✕

JSON Physical Model

Schema for:

Model name: CDM V01
Author:
Version:
File name: CDM V01.1.json
File path: /Users/joshuathiele/Desktop/CDM V01.1.json
Printed On: Wed Jan 20 2021 13:52:41 GMT+0100 (Central European Standard Time)
Created with: Hackolade - Visual data modeling for NoSQL and multimodel databases
1. Model
2. Groups
3. Relationships
1. Model
1.1 Model CDM V01
1.1.1 CDM V01 Entity Relationship Diagram
1.1.2 CDM V01 Properties
1.1.2.1 Details tab
PropertyValue
Model nameCDM V01
Technical name
Description
Author
DB vendorPlain JSON--no DB
Version
Comments
1.1.3 CDM V01 DB Definitions
2. Groups
2.1 Group ConstructionManagement
2.1.1 ConstructionManagement Properties
PropertyValue
Group nameConstructionManagement
Technical name
Activatedtrue
Description
Comments
2.1.2 ConstructionManagement Documents
2.1.2.1 Document Defects
2.1.2.1.1 Defects Tree Diagram
2.1.2.1.2 Defects Properties
PropertyValue
Document nameDefects
Technical name
Activatedtrue
Id
Description
GroupConstructionManagement
RESTful API
Additional propertiesfalse
Comments
2.1.2.1.3 Defects Fields
FieldTypeReqKeyDescriptionComments
DefectsIdstringfalse
ProjectIdstringfalse
2.1.2.1.3.1 Field DefectsId
2.1.2.1.3.1.1 DefectsId properties
PropertyValue
Name DefectsId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.2.1.3.2 Field ProjectId
2.1.2.1.3.2.1 ProjectId properties
PropertyValue
Name ProjectId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.2.1.4 Defects JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Defects",
    "additionalProperties": false,
    "properties": {
        "DefectsId": {
            "type": "string"
        },
        "ProjectId": {
            "type": "string"
        }
    }
}
2.1.2.1.5 Defects JSON data
{
    "DefectsId": "Lorem",
    "ProjectId": "Lorem"
}
2.1.2.2 Document WarrantiesClaims
2.1.2.2.1 WarrantiesClaims Tree Diagram
2.1.2.2.2 WarrantiesClaims Properties
PropertyValue
Document nameWarrantiesClaims
Technical name
Activatedtrue
Id
Description
GroupConstructionManagement
RESTful API
Additional propertiesfalse
Comments
2.1.2.2.3 WarrantiesClaims Fields
FieldTypeReqKeyDescriptionComments
ClaimIdstringfalse
2.1.2.2.3.1 Field ClaimId
2.1.2.2.3.1.1 ClaimId properties
PropertyValue
Name ClaimId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.1.2.2.4 WarrantiesClaims JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "WarrantiesClaims",
    "additionalProperties": false,
    "properties": {
        "ClaimId": {
            "type": "string"
        }
    }
}
2.1.2.2.5 WarrantiesClaims JSON data
{
    "ClaimId": "Lorem"
}
2.2 Group Digital Twin
2.2.1 Digital Twin Properties
PropertyValue
Group nameDigital Twin
Technical name
Activatedtrue
Description
Comments
2.2.2 Digital Twin Documents
2.2.2.1 Document AreaMeasurement
2.2.2.1.1 AreaMeasurement Tree Diagram
2.2.2.1.2 AreaMeasurement Properties
PropertyValue
Document nameAreaMeasurement
Technical nameArMsrmnt
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.1.3 AreaMeasurement Fields
FieldTypeReqKeyDescriptionComments
AreaMeasurementIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

Standardstringfalse

Area measurement standard e.g: GIF, DIN, Not Defined

Typestringfalse

Type of the standard area e.g: NF2, circulation area

Valuenumberfalse

Value of measurement e.g: 200; 100.66; 16.76

[{"dataType":"float"}]

Unitstringfalse

Unit area is measured with e.g: m², ft²

ValidFromstringfalse

Date measurement was taken e.g: 10.10.20

[{"dataType":"dateTime"}]

ValidUntilstringfalse

Date measurement is not valid anymore /needs to be renewed

[{"dataType":"dateTime"}]

SiteIdstringfalse

Reference to the site measurement belongs to

LandIdstringfalse

Reference to the land measurement belongs to

BuildingIdstringfalse

Reference to the building measurement belongs to.

UnitIdstringfalse

Reference to the unit measurement belongs to

SpaceIdstringfalse

Reference to the space measurement belongs to

FloorIdstringfalse

Reference to the floor measurement belongs to

Guidstringfalse

Globally Unique Identifier number

2.2.2.1.3.1 Field AreaMeasurementId
2.2.2.1.3.1.1 AreaMeasurementId properties
PropertyValue
Name AreaMeasurementId
Technical name ArMsrmntd
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.1.3.2 Field Standard
2.2.2.1.3.2.1 Standard properties
PropertyValue
Name Standard
Technical name
Activated true
Id
Type string
Description

Area measurement standard e.g: GIF, DIN, Not Defined

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.1.3.3 Field Type
2.2.2.1.3.3.1 Type properties
PropertyValue
Name Type
Technical name Typ
Activated true
Id
Type string
Description

Type of the standard area e.g: NF2, circulation area

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.1.3.4 Field Value
2.2.2.1.3.4.1 Value properties
PropertyValue
Name Value
Technical name Vl
Activated true
Id
Type number
Description

Value of measurement e.g: 200; 100.66; 16.76

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.1.3.5 Field Unit
2.2.2.1.3.5.1 Unit properties
PropertyValue
Name Unit
Technical name Unt
Activated true
Id
Type string
Description

Unit area is measured with e.g: m², ft²

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.1.3.6 Field ValidFrom
2.2.2.1.3.6.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name VldFrm
Activated true
Id
Type string
Description

Date measurement was taken e.g: 10.10.20

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.1.3.7 Field ValidUntil
2.2.2.1.3.7.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name
Activated true
Id
Type string
Description

Date measurement is not valid anymore /needs to be renewed

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.1.3.8 Field SiteId
2.2.2.1.3.8.1 SiteId properties
PropertyValue
Name SiteId
Technical name
Activated true
Id
Type string
Description

Reference to the site measurement belongs to

Dependencies
Required
Primary key false
Foreign collection Site
Foreign field SiteId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.1.3.9 Field LandId
2.2.2.1.3.9.1 LandId properties
PropertyValue
Name LandId
Technical name
Activated true
Id
Type string
Description

Reference to the land measurement belongs to

Dependencies
Required
Primary key false
Foreign collection Land
Foreign field LandId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.1.3.10 Field BuildingId
2.2.2.1.3.10.1 BuildingId properties
PropertyValue
Name BuildingId
Technical name Bldngd
Activated true
Id
Type string
Description

Reference to the building measurement belongs to.

Dependencies
Required
Primary key false
Foreign collection Building
Foreign field BuildingId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.1.3.11 Field UnitId
2.2.2.1.3.11.1 UnitId properties
PropertyValue
Name UnitId
Technical name
Activated true
Id
Type string
Description

Reference to the unit measurement belongs to

Dependencies
Required
Primary key false
Foreign collection Unit
Foreign field UnitId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.1.3.12 Field SpaceId
2.2.2.1.3.12.1 SpaceId properties
PropertyValue
Name SpaceId
Technical name Spcd
Activated true
Id
Type string
Description

Reference to the space measurement belongs to

Dependencies
Required
Primary key false
Foreign collection Space
Foreign field SpaceId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.1.3.13 Field FloorId
2.2.2.1.3.13.1 FloorId properties
PropertyValue
Name FloorId
Technical name
Activated true
Id
Type string
Description

Reference to the floor measurement belongs to

Dependencies
Required
Primary key false
Foreign collection Floor
Foreign field FloorId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.1.3.14 Field Guid
2.2.2.1.3.14.1 Guid properties
PropertyValue
Name Guid
Technical name
Activated true
Id
Type string
Description

Globally Unique Identifier number

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.1.4 AreaMeasurement JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "AreaMeasurement",
    "additionalProperties": false,
    "properties": {
        "ArMsrmntd": {
            "type": "string",
            "description": "Customer ID from previous system  (ID before onboarding data to BM)"
        },
        "Standard": {
            "type": "string",
            "description": "Area measurement standard e.g: GIF, DIN, Not Defined"
        },
        "Typ": {
            "type": "string",
            "description": "Type of the standard area e.g: NF2, circulation area"
        },
        "Vl": {
            "type": "number",
            "description": "Value of measurement e.g: 200; 100.66; 16.76"
        },
        "Unt": {
            "type": "string",
            "description": "Unit area is measured with e.g: m², ft²"
        },
        "VldFrm": {
            "type": "string",
            "description": "Date measurement was taken e.g: 10.10.20"
        },
        "ValidUntil": {
            "type": "string",
            "description": "Date measurement is not valid anymore /needs to be renewed"
        },
        "SiteId": {
            "type": "string",
            "description": "Reference to the site measurement belongs to"
        },
        "LandId": {
            "type": "string",
            "description": "Reference to the land measurement belongs to"
        },
        "Bldngd": {
            "type": "string",
            "description": "Reference to the building measurement belongs to."
        },
        "UnitId": {
            "type": "string",
            "description": "Reference to the unit measurement belongs to"
        },
        "Spcd": {
            "type": "string",
            "description": "Reference to the space measurement belongs to"
        },
        "FloorId": {
            "type": "string",
            "description": "Reference to the floor measurement belongs to"
        },
        "Guid": {
            "type": "string",
            "description": "Globally Unique Identifier number"
        }
    }
}
2.2.2.1.5 AreaMeasurement JSON data
{
    "ArMsrmntd": "Lorem",
    "Standard": "Lorem",
    "Typ": "Lorem",
    "Vl": -91,
    "Unt": "Lorem",
    "VldFrm": "Lorem",
    "ValidUntil": "Lorem",
    "SiteId": "Lorem",
    "LandId": "Lorem",
    "Bldngd": "Lorem",
    "UnitId": "Lorem",
    "Spcd": "Lorem",
    "FloorId": "Lorem",
    "Guid": "Lorem"
}
2.2.2.2 Document BSensingObject
2.2.2.2.1 BSensingObject Tree Diagram
2.2.2.2.2 BSensingObject Properties
PropertyValue
Document nameBSensingObject
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.2.3 BSensingObject Fields
FieldTypeReqKeyDescriptionComments
BSensingObjectIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

ProductIdstringfalse

Reference to the product which the BSensingObject belongs to

Typestringfalse

Type of sensing object e.g: fire alarm system, gas-warning system, smoke detectors

Classstringfalse

Class of object in this case sensing object

Namestringfalse

Name of sensing object

TransferSystemstringfalse

Does a transfer system exists (Y/N)

NetworkTopologystringfalse

Description of network topology

PowerSupplystringfalse

Power supply of sensing object e.g: long-term battery, short-term battery, centralised supply

NumberOfAntennaenumberfalse

Number of antennae

NumberOfAutomatic Sensorsnumberfalse

Number of automatic sensors

NumberOfCamerasnumberfalse

Number of cameras

NumberOfMonitorsnumberfalse

Number of monitors

NumberOfBoostersnumberfalse

Number of boosters

NumberOfSignalingDevicenumberfalse

Number of signaling devices

NumberOfSmokeExtractorsnumberfalse

Number of smoke extractors

NumberOfSubstationsnumberfalse

Number of substations

RingPipingstringfalse

Info on piping seal

2.2.2.2.3.1 Field BSensingObjectId
2.2.2.2.3.1.1 BSensingObjectId properties
PropertyValue
Name BSensingObjectId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.2.3.2 Field ProductId
2.2.2.2.3.2.1 ProductId properties
PropertyValue
Name ProductId
Technical name
Activated true
Id
Type string
Description

Reference to the product which the BSensingObject belongs to

Dependencies
Required
Primary key false
Foreign collection Product
Foreign field ProductId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.2.3.3 Field Type
2.2.2.2.3.3.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description

Type of sensing object e.g: fire alarm system, gas-warning system, smoke detectors

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.2.3.4 Field Class
2.2.2.2.3.4.1 Class properties
PropertyValue
Name Class
Technical name
Activated true
Id
Type string
Description

Class of object in this case sensing object

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.2.3.5 Field Name
2.2.2.2.3.5.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description

Name of sensing object

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.2.3.6 Field TransferSystem
2.2.2.2.3.6.1 TransferSystem properties
PropertyValue
Name TransferSystem
Technical name
Activated true
Id
Type string
Description

Does a transfer system exists (Y/N)

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.2.3.7 Field NetworkTopology
2.2.2.2.3.7.1 NetworkTopology properties
PropertyValue
Name NetworkTopology
Technical name
Activated true
Id
Type string
Description

Description of network topology

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.2.3.8 Field PowerSupply
2.2.2.2.3.8.1 PowerSupply properties
PropertyValue
Name PowerSupply
Technical name
Activated true
Id
Type string
Description

Power supply of sensing object e.g: long-term battery, short-term battery, centralised supply

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.2.3.9 Field NumberOfAntennae
2.2.2.2.3.9.1 NumberOfAntennae properties
PropertyValue
Name NumberOfAntennae
Technical name
Activated true
Id
Type number
Description

Number of antennae

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.2.3.10 Field NumberOfAutomatic Sensors
2.2.2.2.3.10.1 NumberOfAutomatic Sensors properties
PropertyValue
Name NumberOfAutomatic Sensors
Technical name
Activated true
Id
Type number
Description

Number of automatic sensors

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.2.3.11 Field NumberOfCameras
2.2.2.2.3.11.1 NumberOfCameras properties
PropertyValue
Name NumberOfCameras
Technical name
Activated true
Id
Type number
Description

Number of cameras

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.2.3.12 Field NumberOfMonitors
2.2.2.2.3.12.1 NumberOfMonitors properties
PropertyValue
Name NumberOfMonitors
Technical name
Activated true
Id
Type number
Description

Number of monitors

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.2.3.13 Field NumberOfBoosters
2.2.2.2.3.13.1 NumberOfBoosters properties
PropertyValue
Name NumberOfBoosters
Technical name
Activated true
Id
Type number
Description

Number of boosters

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.2.3.14 Field NumberOfSignalingDevice
2.2.2.2.3.14.1 NumberOfSignalingDevice properties
PropertyValue
Name NumberOfSignalingDevice
Technical name
Activated true
Id
Type number
Description

Number of signaling devices

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.2.3.15 Field NumberOfSmokeExtractors
2.2.2.2.3.15.1 NumberOfSmokeExtractors properties
PropertyValue
Name NumberOfSmokeExtractors
Technical name
Activated true
Id
Type number
Description

Number of smoke extractors

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.2.3.16 Field NumberOfSubstations
2.2.2.2.3.16.1 NumberOfSubstations properties
PropertyValue
Name NumberOfSubstations
Technical name
Activated true
Id
Type number
Description

Number of substations

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.2.3.17 Field RingPiping
2.2.2.2.3.17.1 RingPiping properties
PropertyValue
Name RingPiping
Technical name
Activated true
Id
Type string
Description

Info on piping seal

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.2.4 BSensingObject JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "BSensingObject",
    "additionalProperties": false,
    "properties": {
        "BSensingObjectId": {
            "type": "string",
            "description": "Customer ID from previous system  (ID before onboarding data to BM)"
        },
        "ProductId": {
            "type": "string",
            "description": "Reference to the product which the BSensingObject belongs to"
        },
        "Type": {
            "type": "string",
            "description": "Type of sensing object e.g: fire alarm system, gas-warning system, smoke detectors"
        },
        "Class": {
            "type": "string",
            "description": "Class of object in this case sensing object"
        },
        "Name": {
            "type": "string",
            "description": "Name of sensing object"
        },
        "TransferSystem": {
            "type": "string",
            "description": "Does a transfer system exists (Y/N)"
        },
        "NetworkTopology": {
            "type": "string",
            "description": "Description of network topology"
        },
        "PowerSupply": {
            "type": "string",
            "description": "Power supply of sensing object e.g: long-term battery, short-term battery, centralised supply"
        },
        "NumberOfAntennae": {
            "type": "number",
            "description": "Number of antennae"
        },
        "NumberOfAutomatic Sensors": {
            "type": "number",
            "description": "Number of automatic sensors"
        },
        "NumberOfCameras": {
            "type": "number",
            "description": "Number of cameras"
        },
        "NumberOfMonitors": {
            "type": "number",
            "description": "Number of monitors"
        },
        "NumberOfBoosters": {
            "type": "number",
            "description": "Number of boosters"
        },
        "NumberOfSignalingDevice": {
            "type": "number",
            "description": "Number of signaling devices"
        },
        "NumberOfSmokeExtractors": {
            "type": "number",
            "description": "Number of smoke extractors"
        },
        "NumberOfSubstations": {
            "type": "number",
            "description": "Number of substations"
        },
        "RingPiping": {
            "type": "string",
            "description": "Info on piping seal"
        }
    }
}
2.2.2.2.5 BSensingObject JSON data
{
    "BSensingObjectId": "Lorem",
    "ProductId": "Lorem",
    "Type": "Lorem",
    "Class": "Lorem",
    "Name": "Lorem",
    "TransferSystem": "Lorem",
    "NetworkTopology": "Lorem",
    "PowerSupply": "Lorem",
    "NumberOfAntennae": 15,
    "NumberOfAutomatic Sensors": -51,
    "NumberOfCameras": -62,
    "NumberOfMonitors": -50,
    "NumberOfBoosters": -27,
    "NumberOfSignalingDevice": -3,
    "NumberOfSmokeExtractors": 61,
    "NumberOfSubstations": 8,
    "RingPiping": "Lorem"
}
2.2.2.3 Document Building
2.2.2.3.1 Building Tree Diagram
2.2.2.3.2 Building Properties
PropertyValue
Document nameBuilding
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.3.3 Building Fields
FieldTypeReqKeyDescriptionComments
BuildingIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

BuildingCodestringfalse

User specific Building Code e.g: BC001

Namestringfalse

User specific building name e.g: EMEA Headquarter, Office Berlin

Typestringfalse

Type of building use e.g: office, storage, production

BuildingClassstringfalse

Energy Class of Building e.g: A

ValidFromstringfalse

Date construction process is finished or lease contract started e.g: 10.10.20

[{"dataType":"dateTime"}]

ValidUntilstringtrue

Date building is either sold, demolished or lease contract ends e.g: 12.10.23

[{"dataType":"dateTime"}]

ConstructionYearstringfalse

Year of construction e.g: 2002

[{"dataType":"dateTime"}]

ParkingSpacesnumberfalse

Number of parking spaces

EnergyTypestringfalse

Type of energy used

WaterTypestringfalse

Type of water used

HeatingType1stringfalse

Primary Type of heating

HeatingType2stringfalse

Secondary Type of heating

AirConditioningbooleanfalse

Does air conditioning exist? (Y/N) (Needed for precise future emissions projection of building)

PrimaryUsagestringfalse

E.g. Office, Residential, Data room etc.

SecondaryUsagestringfalse

E.g. Office, Residential, Data room etc.

PortfolioIdstringfalse

Reference to the Portfolio which the building belongs to

LandIdstringfalse

Reference to the Land which the building belongs to

SiteIdstringfalse

Reference to the Site which the building belongs to

CertificateIdstringfalse

Reference to the certificate which belongs to the building

AddressIdstringfalse

Reference to Address which the building belongs to

Guidstringfalse

Globally Unique Identifier number

2.2.2.3.3.1 Field BuildingId
2.2.2.3.3.1.1 BuildingId properties
PropertyValue
Name BuildingId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.3.3.2 Field BuildingCode
2.2.2.3.3.2.1 BuildingCode properties
PropertyValue
Name BuildingCode
Technical name
Activated true
Id
Type string
Description

User specific Building Code e.g: BC001

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.3.3.3 Field Name
2.2.2.3.3.3.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description

User specific building name e.g: EMEA Headquarter, Office Berlin

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.3.3.4 Field Type
2.2.2.3.3.4.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description

Type of building use e.g: office, storage, production

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.3.3.5 Field BuildingClass
2.2.2.3.3.5.1 BuildingClass properties
PropertyValue
Name BuildingClass
Technical name
Activated true
Id
Type string
Description

Energy Class of Building e.g: A

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.3.3.6 Field ValidFrom
2.2.2.3.3.6.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name VldFrm
Activated true
Id
Type string
Description

Date construction process is finished or lease contract started e.g: 10.10.20

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.3.3.7 Field ValidUntil
2.2.2.3.3.7.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name Vldntl
Activated true
Id
Type string
Description

Date building is either sold, demolished or lease contract ends e.g: 12.10.23

Dependencies
Required true
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.3.3.8 Field ConstructionYear
2.2.2.3.3.8.1 ConstructionYear properties
PropertyValue
Name ConstructionYear
Technical name
Activated true
Id
Type string
Description

Year of construction e.g: 2002

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.3.3.9 Field ParkingSpaces
2.2.2.3.3.9.1 ParkingSpaces properties
PropertyValue
Name ParkingSpaces
Technical name
Activated true
Id
Type number
Description

Number of parking spaces

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.3.3.10 Field EnergyType
2.2.2.3.3.10.1 EnergyType properties
PropertyValue
Name EnergyType
Technical name
Activated true
Id
Type string
Description

Type of energy used

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.3.3.11 Field WaterType
2.2.2.3.3.11.1 WaterType properties
PropertyValue
Name WaterType
Technical name
Activated true
Id
Type string
Description

Type of water used

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.3.3.12 Field HeatingType1
2.2.2.3.3.12.1 HeatingType1 properties
PropertyValue
Name HeatingType1
Technical name
Activated true
Id
Type string
Description

Primary Type of heating

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.3.3.13 Field HeatingType2
2.2.2.3.3.13.1 HeatingType2 properties
PropertyValue
Name HeatingType2
Technical name
Activated true
Id
Type string
Description

Secondary Type of heating

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.3.3.14 Field AirConditioning
2.2.2.3.3.14.1 AirConditioning properties
PropertyValue
Name AirConditioning
Technical name
Activated true
Id
Type boolean
Description

Does air conditioning exist? (Y/N) (Needed for precise future emissions projection of building)

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Sample
Comments
2.2.2.3.3.15 Field PrimaryUsage
2.2.2.3.3.15.1 PrimaryUsage properties
PropertyValue
Name PrimaryUsage
Technical name
Activated true
Id
Type string
Description

E.g. Office, Residential, Data room etc.

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.3.3.16 Field SecondaryUsage
2.2.2.3.3.16.1 SecondaryUsage properties
PropertyValue
Name SecondaryUsage
Technical name
Activated true
Id
Type string
Description

E.g. Office, Residential, Data room etc.

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.3.3.17 Field PortfolioId
2.2.2.3.3.17.1 PortfolioId properties
PropertyValue
Name PortfolioId
Technical name Prtfld
Activated true
Id
Type string
Description

Reference to the Portfolio which the building belongs to

Dependencies
Required
Primary key false
Foreign collection Portfolio
Foreign field PortfolioId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.3.3.18 Field LandId
2.2.2.3.3.18.1 LandId properties
PropertyValue
Name LandId
Technical name Lndd
Activated true
Id
Type string
Description

Reference to the Land which the building belongs to

Dependencies
Required
Primary key false
Foreign collection Land
Foreign field LandId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.3.3.19 Field SiteId
2.2.2.3.3.19.1 SiteId properties
PropertyValue
Name SiteId
Technical name Std
Activated true
Id
Type string
Description

Reference to the Site which the building belongs to

Dependencies
Required
Primary key false
Foreign collection Site
Foreign field SiteId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.3.3.20 Field CertificateId
2.2.2.3.3.20.1 CertificateId properties
PropertyValue
Name CertificateId
Technical name
Activated true
Id
Type string
Description

Reference to the certificate which belongs to the building

Dependencies
Required
Primary key
Foreign collection Certificate
Foreign field CertificateId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.3.3.21 Field AddressId
2.2.2.3.3.21.1 AddressId properties
PropertyValue
Name AddressId
Technical name
Activated true
Id
Type string
Description

Reference to Address which the building belongs to

Dependencies
Required
Primary key false
Foreign collection Address1
Foreign field AddressId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.3.3.22 Field Guid
2.2.2.3.3.22.1 Guid properties
PropertyValue
Name Guid
Technical name
Activated true
Id
Type string
Description

Globally Unique Identifier number

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.3.4 Building JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Building",
    "additionalProperties": false,
    "properties": {
        "BuildingId": {
            "type": "string",
            "description": "Customer ID from previous system (ID before onboarding data to BM)"
        },
        "BuildingCode": {
            "type": "string",
            "description": "User specific Building Code e.g: BC001"
        },
        "Name": {
            "type": "string",
            "description": "User specific building name e.g: EMEA Headquarter, Office Berlin"
        },
        "Type": {
            "type": "string",
            "description": "Type of building use e.g: office, storage, production"
        },
        "BuildingClass": {
            "type": "string",
            "description": "Energy Class of Building e.g: A"
        },
        "VldFrm": {
            "type": "string",
            "description": "Date construction process is finished or lease contract started e.g: 10.10.20"
        },
        "Vldntl": {
            "type": "string",
            "description": "Date building is either sold, demolished or lease contract ends e.g: 12.10.23 "
        },
        "ConstructionYear": {
            "type": "string",
            "description": "Year of construction e.g: 2002"
        },
        "ParkingSpaces": {
            "type": "number",
            "description": "Number of parking spaces"
        },
        "EnergyType": {
            "type": "string",
            "description": "Type of energy used"
        },
        "WaterType": {
            "type": "string",
            "description": "Type of water used"
        },
        "HeatingType1": {
            "type": "string",
            "description": "Primary Type of heating"
        },
        "HeatingType2": {
            "type": "string",
            "description": "Secondary Type of heating"
        },
        "AirConditioning": {
            "type": "boolean",
            "description": "Does air conditioning exist? (Y/N) (Needed for precise  future emissions projection of building)"
        },
        "PrimaryUsage": {
            "type": "string",
            "description": "E.g. Office, Residential, Data room etc."
        },
        "SecondaryUsage": {
            "type": "string",
            "description": "E.g. Office, Residential, Data room etc."
        },
        "Prtfld": {
            "type": "string",
            "description": "Reference to the Portfolio which the building belongs to"
        },
        "Lndd": {
            "type": "string",
            "description": "Reference to the Land which the building belongs to"
        },
        "Std": {
            "type": "string",
            "description": "Reference to the Site which the building belongs to"
        },
        "CertificateId": {
            "type": "string",
            "description": "Reference to the certificate which belongs to the building"
        },
        "AddressId": {
            "type": "string",
            "description": "Reference to Address which the building belongs to"
        },
        "Guid": {
            "type": "string",
            "description": "Globally Unique Identifier number"
        }
    },
    "required": [
        "Vldntl"
    ]
}
2.2.2.3.5 Building JSON data
{
    "BuildingId": "Lorem",
    "BuildingCode": "Lorem",
    "Name": "Lorem",
    "Type": "Lorem",
    "BuildingClass": "Lorem",
    "VldFrm": "Lorem",
    "Vldntl": "Lorem",
    "ConstructionYear": "Lorem",
    "ParkingSpaces": 28,
    "EnergyType": "Lorem",
    "WaterType": "Lorem",
    "HeatingType1": "Lorem",
    "HeatingType2": "Lorem",
    "AirConditioning": true,
    "PrimaryUsage": "Lorem",
    "SecondaryUsage": "Lorem",
    "Prtfld": "Lorem",
    "Lndd": "Lorem",
    "Std": "Lorem",
    "CertificateId": "Lorem",
    "AddressId": "Lorem",
    "Guid": "Lorem"
}
2.2.2.4 Document CStoringObject
2.2.2.4.1 CStoringObject Tree Diagram
2.2.2.4.2 CStoringObject Properties
PropertyValue
Document nameCStoringObject
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.4.3 CStoringObject Fields
FieldTypeReqKeyDescriptionComments
CStoringObjectIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

ProductIdstringfalse

Reference to the product which the storing object belongs to

Typestringfalse

Type of storing object e.g: compressed air tank, heating oil tank, expansion vessel

Classstringfalse

Class of object in this case storing object

Namestringfalse

Name of storing object

ContainerVolumenumberfalse

Volume of container e.g: 55.6; 460; 1000

[{"dataType":"float"}]

FillingWeightnumberfalse

Weight of storing object including the filling

[{"dataType":"float"}]

Installationstringfalse

Type of installation e.g: earth installation, open space installation

NominalVolumenumberfalse

Largest possible volume of container e.g: 20.5; 250; 400

[{"dataType":"float"}]

NumberOfContainersnumberfalse

Number of different storing containers

StorageVolumenumberfalse

Actual storage volume of StoringObject

[{"dataType":"float"}]

TotalVolumenumberfalse

Total volume of storing object

[{"dataType":"float"}]

Volumenumberfalse

[{"dataType":"float"}]

OperatingPressurenumberfalse

Pressure while being in operation

[{"dataType":"float"}]

2.2.2.4.3.1 Field CStoringObjectId
2.2.2.4.3.1.1 CStoringObjectId properties
PropertyValue
Name CStoringObjectId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.4.3.2 Field ProductId
2.2.2.4.3.2.1 ProductId properties
PropertyValue
Name ProductId
Technical name
Activated true
Id
Type string
Description

Reference to the product which the storing object belongs to

Dependencies
Required
Primary key false
Foreign collection Product
Foreign field ProductId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.4.3.3 Field Type
2.2.2.4.3.3.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description

Type of storing object e.g: compressed air tank, heating oil tank, expansion vessel

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.4.3.4 Field Class
2.2.2.4.3.4.1 Class properties
PropertyValue
Name Class
Technical name
Activated true
Id
Type string
Description

Class of object in this case storing object

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.4.3.5 Field Name
2.2.2.4.3.5.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description

Name of storing object

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.4.3.6 Field ContainerVolume
2.2.2.4.3.6.1 ContainerVolume properties
PropertyValue
Name ContainerVolume
Technical name
Activated true
Id
Type number
Description

Volume of container e.g: 55.6; 460; 1000

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.4.3.7 Field FillingWeight
2.2.2.4.3.7.1 FillingWeight properties
PropertyValue
Name FillingWeight
Technical name
Activated true
Id
Type number
Description

Weight of storing object including the filling

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.4.3.8 Field Installation
2.2.2.4.3.8.1 Installation properties
PropertyValue
Name Installation
Technical name
Activated true
Id
Type string
Description

Type of installation e.g: earth installation, open space installation

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.4.3.9 Field NominalVolume
2.2.2.4.3.9.1 NominalVolume properties
PropertyValue
Name NominalVolume
Technical name
Activated true
Id
Type number
Description

Largest possible volume of container e.g: 20.5; 250; 400

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.4.3.10 Field NumberOfContainers
2.2.2.4.3.10.1 NumberOfContainers properties
PropertyValue
Name NumberOfContainers
Technical name
Activated true
Id
Type number
Description

Number of different storing containers

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.4.3.11 Field StorageVolume
2.2.2.4.3.11.1 StorageVolume properties
PropertyValue
Name StorageVolume
Technical name
Activated true
Id
Type number
Description

Actual storage volume of StoringObject

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.4.3.12 Field TotalVolume
2.2.2.4.3.12.1 TotalVolume properties
PropertyValue
Name TotalVolume
Technical name
Activated true
Id
Type number
Description

Total volume of storing object

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.4.3.13 Field Volume
2.2.2.4.3.13.1 Volume properties
PropertyValue
Name Volume
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.4.3.14 Field OperatingPressure
2.2.2.4.3.14.1 OperatingPressure properties
PropertyValue
Name OperatingPressure
Technical name
Activated true
Id
Type number
Description

Pressure while being in operation

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.4.4 CStoringObject JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "CStoringObject",
    "additionalProperties": false,
    "properties": {
        "CStoringObjectId": {
            "type": "string",
            "description": "Customer ID from previous system  (ID before onboarding data to BM)"
        },
        "ProductId": {
            "type": "string",
            "description": "Reference to the product which the storing object belongs to"
        },
        "Type": {
            "type": "string",
            "description": "Type of storing object e.g: compressed air tank, heating oil tank, expansion vessel"
        },
        "Class": {
            "type": "string",
            "description": "Class of object in this case storing object"
        },
        "Name": {
            "type": "string",
            "description": "Name of storing object"
        },
        "ContainerVolume": {
            "type": "number",
            "description": "Volume of container e.g: 55.6; 460; 1000"
        },
        "FillingWeight": {
            "type": "number",
            "description": "Weight of storing object including the filling"
        },
        "Installation": {
            "type": "string",
            "description": "Type of installation e.g: earth installation, open space installation"
        },
        "NominalVolume": {
            "type": "number",
            "description": "Largest possible volume of container e.g: 20.5; 250; 400"
        },
        "NumberOfContainers": {
            "type": "number",
            "description": "Number of different storing containers"
        },
        "StorageVolume": {
            "type": "number",
            "description": "Actual storage volume of StoringObject"
        },
        "TotalVolume": {
            "type": "number",
            "description": "Total volume of storing object"
        },
        "Volume": {
            "type": "number"
        },
        "OperatingPressure": {
            "type": "number",
            "description": "Pressure while being in operation"
        }
    }
}
2.2.2.4.5 CStoringObject JSON data
{
    "CStoringObjectId": "Lorem",
    "ProductId": "Lorem",
    "Type": "Lorem",
    "Class": "Lorem",
    "Name": "Lorem",
    "ContainerVolume": 43,
    "FillingWeight": 93,
    "Installation": "Lorem",
    "NominalVolume": -1,
    "NumberOfContainers": 30,
    "StorageVolume": -95,
    "TotalVolume": -64,
    "Volume": -91,
    "OperatingPressure": 54
}
2.2.2.5 Document Certificate
2.2.2.5.1 Certificate Tree Diagram
2.2.2.5.2 Certificate Properties
PropertyValue
Document nameCertificate
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.5.3 Certificate Fields
FieldTypeReqKeyDescriptionComments
CertificateIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

BuildingIdstringfalse

Reference to the Building which the building belongs to

Typestringfalse

Type of Certificate e.g: LEED, BREEAM, DGNB

Namestringfalse

Name of Certificate e.g: DGNB Platin, DGNB Silber, DGNB Bronze

Valuestringfalse

E.g. Score, Grade if applicable for the certificate, A++

IssuingDatestringfalse

Date certificate was issued

[{"dataType":"DateTime"}]

ValidFromstringfalse

Date certificate is valid from e.g: 10.10.20

[{"dataType":"dateTime"}]

ValidUntilstringfalse

Date certificate expires e.g: 12.10.23

[{"dataType":"dateTime"}]

Guidstringfalse

Globally Unique Identifier number

2.2.2.5.3.1 Field CertificateId
2.2.2.5.3.1.1 CertificateId properties
PropertyValue
Name CertificateId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.5.3.2 Field BuildingId
2.2.2.5.3.2.1 BuildingId properties
PropertyValue
Name BuildingId
Technical name
Activated true
Id
Type string
Description

Reference to the Building which the building belongs to

Dependencies
Required
Primary key false
Foreign collection Building
Foreign field BuildingId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.5.3.3 Field Type
2.2.2.5.3.3.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description

Type of Certificate e.g: LEED, BREEAM, DGNB

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.5.3.4 Field Name
2.2.2.5.3.4.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description

Name of Certificate e.g: DGNB Platin, DGNB Silber, DGNB Bronze

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.5.3.5 Field Value
2.2.2.5.3.5.1 Value properties
PropertyValue
Name Value
Technical name
Activated true
Id
Type string
Description

E.g. Score, Grade if applicable for the certificate, A++

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.5.3.6 Field IssuingDate
2.2.2.5.3.6.1 IssuingDate properties
PropertyValue
Name IssuingDate
Technical name
Activated true
Id
Type string
Description

Date certificate was issued

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"DateTime"}]

2.2.2.5.3.7 Field ValidFrom
2.2.2.5.3.7.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name
Activated true
Id
Type string
Description

Date certificate is valid from e.g: 10.10.20

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.5.3.8 Field ValidUntil
2.2.2.5.3.8.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name
Activated true
Id
Type string
Description

Date certificate expires e.g: 12.10.23

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.5.3.9 Field Guid
2.2.2.5.3.9.1 Guid properties
PropertyValue
Name Guid
Technical name
Activated true
Id
Type string
Description

Globally Unique Identifier number

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.5.4 Certificate JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Certificate",
    "additionalProperties": false,
    "properties": {
        "CertificateId": {
            "type": "string",
            "description": "Customer ID from previous system  (ID before onboarding data to BM)"
        },
        "BuildingId": {
            "type": "string",
            "description": "Reference to the Building which the building belongs to"
        },
        "Type": {
            "type": "string",
            "description": "Type of Certificate e.g: LEED, BREEAM, DGNB"
        },
        "Name": {
            "type": "string",
            "description": "Name of Certificate e.g: DGNB Platin, DGNB Silber, DGNB Bronze"
        },
        "Value": {
            "type": "string",
            "description": "E.g. Score, Grade if applicable for the certificate, A++"
        },
        "IssuingDate": {
            "type": "string",
            "description": "Date certificate was issued"
        },
        "ValidFrom": {
            "type": "string",
            "description": "Date certificate is valid from e.g: 10.10.20"
        },
        "ValidUntil": {
            "type": "string",
            "description": "Date certificate expires  e.g: 12.10.23 "
        },
        "Guid": {
            "type": "string",
            "description": "Globally Unique Identifier number"
        }
    }
}
2.2.2.5.5 Certificate JSON data
{
    "CertificateId": "Lorem",
    "BuildingId": "Lorem",
    "Type": "Lorem",
    "Name": "Lorem",
    "Value": "Lorem",
    "IssuingDate": "Lorem",
    "ValidFrom": "Lorem",
    "ValidUntil": "Lorem",
    "Guid": "Lorem"
}
2.2.2.6 Document EEmittingObject
2.2.2.6.1 EEmittingObject Tree Diagram
2.2.2.6.2 EEmittingObject Properties
PropertyValue
Document nameEEmittingObject
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.6.3 EEmittingObject Fields
FieldTypeReqKeyDescriptionComments
EEmittingObjectIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

ProductIdstringfalse

Reference to the product which the emitting object belongs to

Typestringfalse
Classstringfalse
Namestringfalse
CollectorSurfacestringfalse
ConnectiontosecondaryCircuitstringfalse
CoolingMediumTypestringfalse
DecentralizedConstructionstringfalse
Dehumidifyingstringfalse
Densitynumberfalse

[{"dataType":"float"}]

DriveEnergystringfalse
ElectricalPowernumberfalse

[{"dataType":"float"}]

EnergyEfficiencyClassstringfalse
EnergySupplynumberfalse

[{"dataType":"float"}]

ExhaustAirVolumeFlownumberfalse

[{"dataType":"float"}]

ExtinguishingAgentstringfalse
FireClassstringfalse
FireExtinguisherTransportTypestringfalse
FittingTypestringfalse
Fuelstringfalse
GrateTypestringfalse
HeatingTypestringfalse
FilterClassstringfalse
Humidifyingstringfalse
InstallationSitestringfalse
InstalledElectricalLoadnumberfalse

[{"dataType":"float"}]

InsulationThicknessstringfalse
MaximumBurnerCapacitynumberfalse

[{"dataType":"float"}]

MaximumVolumeFlownumberfalse

[{"dataType":"float"}]

MinimumBurnerCapacitynumberfalse

[{"dataType":"float"}]

MediumSuppliedstringfalse
NominalPowernumberfalse

[{"dataType":"float"}]

NumberOfAlarmValveStationsnumberfalse

Number of alarm valve stations

NumberOfCirculationPumpsnumberfalse

Number of circulation pumps

NumberOfCompartmentValvesnumberfalse

Number of compartment valve

NumberOfHeatingCircuitsnumberfalse

Number of heating circuits

NumberOfCoolingCircuitsnumberfalse

Number of cooling circuits

NumberOfInletsnumberfalse

Number of Inlets

NumberOfSprinklerHeadsnumberfalse

Number of sprinkler heads

NumberOfSupplyPointsnumberfalse

Number of supply points

NumberOfZoneChecksnumberfalse

Number of zone checks

OperatingModestringfalse
PipingSystemstringfalse
Powernumberfalse

[{"dataType":"float"}]

PurposeOfHeatingstringfalse
RadiatorTypestringfalse
RecoolingSystemTypestringfalse
RecoolingUnitTypestringfalse
StorageColumestringfalse
ThearmalHeatingPowernumberfalse

[{"dataType":"float"}]

ThermalPowernumberfalse

[{"dataType":"float"}]

TraceHeatingstringfalse
WaterSupplystringfalse
2.2.2.6.3.1 Field EEmittingObjectId
2.2.2.6.3.1.1 EEmittingObjectId properties
PropertyValue
Name EEmittingObjectId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.2 Field ProductId
2.2.2.6.3.2.1 ProductId properties
PropertyValue
Name ProductId
Technical name
Activated true
Id
Type string
Description

Reference to the product which the emitting object belongs to

Dependencies
Required
Primary key false
Foreign collection Product
Foreign field ProductId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.3 Field Type
2.2.2.6.3.3.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.4 Field Class
2.2.2.6.3.4.1 Class properties
PropertyValue
Name Class
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.5 Field Name
2.2.2.6.3.5.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.6 Field CollectorSurface
2.2.2.6.3.6.1 CollectorSurface properties
PropertyValue
Name CollectorSurface
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.7 Field ConnectiontosecondaryCircuit
2.2.2.6.3.7.1 ConnectiontosecondaryCircuit properties
PropertyValue
Name ConnectiontosecondaryCircuit
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.8 Field CoolingMediumType
2.2.2.6.3.8.1 CoolingMediumType properties
PropertyValue
Name CoolingMediumType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.9 Field DecentralizedConstruction
2.2.2.6.3.9.1 DecentralizedConstruction properties
PropertyValue
Name DecentralizedConstruction
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.10 Field Dehumidifying
2.2.2.6.3.10.1 Dehumidifying properties
PropertyValue
Name Dehumidifying
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.11 Field Density
2.2.2.6.3.11.1 Density properties
PropertyValue
Name Density
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.6.3.12 Field DriveEnergy
2.2.2.6.3.12.1 DriveEnergy properties
PropertyValue
Name DriveEnergy
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.13 Field ElectricalPower
2.2.2.6.3.13.1 ElectricalPower properties
PropertyValue
Name ElectricalPower
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.6.3.14 Field EnergyEfficiencyClass
2.2.2.6.3.14.1 EnergyEfficiencyClass properties
PropertyValue
Name EnergyEfficiencyClass
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.15 Field EnergySupply
2.2.2.6.3.15.1 EnergySupply properties
PropertyValue
Name EnergySupply
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.6.3.16 Field ExhaustAirVolumeFlow
2.2.2.6.3.16.1 ExhaustAirVolumeFlow properties
PropertyValue
Name ExhaustAirVolumeFlow
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.6.3.17 Field ExtinguishingAgent
2.2.2.6.3.17.1 ExtinguishingAgent properties
PropertyValue
Name ExtinguishingAgent
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.18 Field FireClass
2.2.2.6.3.18.1 FireClass properties
PropertyValue
Name FireClass
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.19 Field FireExtinguisherTransportType
2.2.2.6.3.19.1 FireExtinguisherTransportType properties
PropertyValue
Name FireExtinguisherTransportType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.20 Field FittingType
2.2.2.6.3.20.1 FittingType properties
PropertyValue
Name FittingType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.21 Field Fuel
2.2.2.6.3.21.1 Fuel properties
PropertyValue
Name Fuel
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.22 Field GrateType
2.2.2.6.3.22.1 GrateType properties
PropertyValue
Name GrateType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.23 Field HeatingType
2.2.2.6.3.23.1 HeatingType properties
PropertyValue
Name HeatingType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.24 Field FilterClass
2.2.2.6.3.24.1 FilterClass properties
PropertyValue
Name FilterClass
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.25 Field Humidifying
2.2.2.6.3.25.1 Humidifying properties
PropertyValue
Name Humidifying
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.26 Field InstallationSite
2.2.2.6.3.26.1 InstallationSite properties
PropertyValue
Name InstallationSite
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.27 Field InstalledElectricalLoad
2.2.2.6.3.27.1 InstalledElectricalLoad properties
PropertyValue
Name InstalledElectricalLoad
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.6.3.28 Field InsulationThickness
2.2.2.6.3.28.1 InsulationThickness properties
PropertyValue
Name InsulationThickness
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.29 Field MaximumBurnerCapacity
2.2.2.6.3.29.1 MaximumBurnerCapacity properties
PropertyValue
Name MaximumBurnerCapacity
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.6.3.30 Field MaximumVolumeFlow
2.2.2.6.3.30.1 MaximumVolumeFlow properties
PropertyValue
Name MaximumVolumeFlow
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.6.3.31 Field MinimumBurnerCapacity
2.2.2.6.3.31.1 MinimumBurnerCapacity properties
PropertyValue
Name MinimumBurnerCapacity
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.6.3.32 Field MediumSupplied
2.2.2.6.3.32.1 MediumSupplied properties
PropertyValue
Name MediumSupplied
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.33 Field NominalPower
2.2.2.6.3.33.1 NominalPower properties
PropertyValue
Name NominalPower
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.6.3.34 Field NumberOfAlarmValveStations
2.2.2.6.3.34.1 NumberOfAlarmValveStations properties
PropertyValue
Name NumberOfAlarmValveStations
Technical name
Activated true
Id
Type number
Description

Number of alarm valve stations

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.6.3.35 Field NumberOfCirculationPumps
2.2.2.6.3.35.1 NumberOfCirculationPumps properties
PropertyValue
Name NumberOfCirculationPumps
Technical name
Activated true
Id
Type number
Description

Number of circulation pumps

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.6.3.36 Field NumberOfCompartmentValves
2.2.2.6.3.36.1 NumberOfCompartmentValves properties
PropertyValue
Name NumberOfCompartmentValves
Technical name
Activated true
Id
Type number
Description

Number of compartment valve

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.6.3.37 Field NumberOfHeatingCircuits
2.2.2.6.3.37.1 NumberOfHeatingCircuits properties
PropertyValue
Name NumberOfHeatingCircuits
Technical name
Activated true
Id
Type number
Description

Number of heating circuits

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.6.3.38 Field NumberOfCoolingCircuits
2.2.2.6.3.38.1 NumberOfCoolingCircuits properties
PropertyValue
Name NumberOfCoolingCircuits
Technical name
Activated true
Id
Type number
Description

Number of cooling circuits

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.6.3.39 Field NumberOfInlets
2.2.2.6.3.39.1 NumberOfInlets properties
PropertyValue
Name NumberOfInlets
Technical name
Activated true
Id
Type number
Description

Number of Inlets

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.6.3.40 Field NumberOfSprinklerHeads
2.2.2.6.3.40.1 NumberOfSprinklerHeads properties
PropertyValue
Name NumberOfSprinklerHeads
Technical name
Activated true
Id
Type number
Description

Number of sprinkler heads

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.6.3.41 Field NumberOfSupplyPoints
2.2.2.6.3.41.1 NumberOfSupplyPoints properties
PropertyValue
Name NumberOfSupplyPoints
Technical name
Activated true
Id
Type number
Description

Number of supply points

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.6.3.42 Field NumberOfZoneChecks
2.2.2.6.3.42.1 NumberOfZoneChecks properties
PropertyValue
Name NumberOfZoneChecks
Technical name
Activated true
Id
Type number
Description

Number of zone checks

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.6.3.43 Field OperatingMode
2.2.2.6.3.43.1 OperatingMode properties
PropertyValue
Name OperatingMode
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.44 Field PipingSystem
2.2.2.6.3.44.1 PipingSystem properties
PropertyValue
Name PipingSystem
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.45 Field Power
2.2.2.6.3.45.1 Power properties
PropertyValue
Name Power
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.6.3.46 Field PurposeOfHeating
2.2.2.6.3.46.1 PurposeOfHeating properties
PropertyValue
Name PurposeOfHeating
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.47 Field RadiatorType
2.2.2.6.3.47.1 RadiatorType properties
PropertyValue
Name RadiatorType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.48 Field RecoolingSystemType
2.2.2.6.3.48.1 RecoolingSystemType properties
PropertyValue
Name RecoolingSystemType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.49 Field RecoolingUnitType
2.2.2.6.3.49.1 RecoolingUnitType properties
PropertyValue
Name RecoolingUnitType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.50 Field StorageColume
2.2.2.6.3.50.1 StorageColume properties
PropertyValue
Name StorageColume
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.51 Field ThearmalHeatingPower
2.2.2.6.3.51.1 ThearmalHeatingPower properties
PropertyValue
Name ThearmalHeatingPower
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.6.3.52 Field ThermalPower
2.2.2.6.3.52.1 ThermalPower properties
PropertyValue
Name ThermalPower
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.6.3.53 Field TraceHeating
2.2.2.6.3.53.1 TraceHeating properties
PropertyValue
Name TraceHeating
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.3.54 Field WaterSupply
2.2.2.6.3.54.1 WaterSupply properties
PropertyValue
Name WaterSupply
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.6.4 EEmittingObject JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "EEmittingObject",
    "additionalProperties": false,
    "properties": {
        "EEmittingObjectId": {
            "type": "string",
            "description": "Customer ID from previous system  (ID before onboarding data to BM)"
        },
        "ProductId": {
            "type": "string",
            "description": "Reference to the product which the emitting object belongs to"
        },
        "Type": {
            "type": "string"
        },
        "Class": {
            "type": "string"
        },
        "Name": {
            "type": "string"
        },
        "CollectorSurface": {
            "type": "string"
        },
        "ConnectiontosecondaryCircuit": {
            "type": "string"
        },
        "CoolingMediumType": {
            "type": "string"
        },
        "DecentralizedConstruction": {
            "type": "string"
        },
        "Dehumidifying": {
            "type": "string"
        },
        "Density": {
            "type": "number"
        },
        "DriveEnergy": {
            "type": "string"
        },
        "ElectricalPower": {
            "type": "number"
        },
        "EnergyEfficiencyClass": {
            "type": "string"
        },
        "EnergySupply": {
            "type": "number"
        },
        "ExhaustAirVolumeFlow": {
            "type": "number"
        },
        "ExtinguishingAgent": {
            "type": "string"
        },
        "FireClass": {
            "type": "string"
        },
        "FireExtinguisherTransportType": {
            "type": "string"
        },
        "FittingType": {
            "type": "string"
        },
        "Fuel": {
            "type": "string"
        },
        "GrateType": {
            "type": "string"
        },
        "HeatingType": {
            "type": "string"
        },
        "FilterClass": {
            "type": "string"
        },
        "Humidifying": {
            "type": "string"
        },
        "InstallationSite": {
            "type": "string"
        },
        "InstalledElectricalLoad": {
            "type": "number"
        },
        "InsulationThickness": {
            "type": "string"
        },
        "MaximumBurnerCapacity": {
            "type": "number"
        },
        "MaximumVolumeFlow": {
            "type": "number"
        },
        "MinimumBurnerCapacity": {
            "type": "number"
        },
        "MediumSupplied": {
            "type": "string"
        },
        "NominalPower": {
            "type": "number"
        },
        "NumberOfAlarmValveStations": {
            "type": "number",
            "description": "Number of alarm valve stations"
        },
        "NumberOfCirculationPumps": {
            "type": "number",
            "description": "Number of circulation pumps"
        },
        "NumberOfCompartmentValves": {
            "type": "number",
            "description": "Number of compartment valve"
        },
        "NumberOfHeatingCircuits": {
            "type": "number",
            "description": "Number of heating circuits"
        },
        "NumberOfCoolingCircuits": {
            "type": "number",
            "description": "Number of cooling circuits"
        },
        "NumberOfInlets": {
            "type": "number",
            "description": "Number of Inlets"
        },
        "NumberOfSprinklerHeads": {
            "type": "number",
            "description": "Number of sprinkler heads"
        },
        "NumberOfSupplyPoints": {
            "type": "number",
            "description": "Number of supply points"
        },
        "NumberOfZoneChecks": {
            "type": "number",
            "description": "Number of zone checks"
        },
        "OperatingMode": {
            "type": "string"
        },
        "PipingSystem": {
            "type": "string"
        },
        "Power": {
            "type": "number"
        },
        "PurposeOfHeating": {
            "type": "string"
        },
        "RadiatorType": {
            "type": "string"
        },
        "RecoolingSystemType": {
            "type": "string"
        },
        "RecoolingUnitType": {
            "type": "string"
        },
        "StorageColume": {
            "type": "string"
        },
        "ThearmalHeatingPower": {
            "type": "number"
        },
        "ThermalPower": {
            "type": "number"
        },
        "TraceHeating": {
            "type": "string"
        },
        "WaterSupply": {
            "type": "string"
        }
    }
}
2.2.2.6.5 EEmittingObject JSON data
{
    "EEmittingObjectId": "Lorem",
    "ProductId": "Lorem",
    "Type": "Lorem",
    "Class": "Lorem",
    "Name": "Lorem",
    "CollectorSurface": "Lorem",
    "ConnectiontosecondaryCircuit": "Lorem",
    "CoolingMediumType": "Lorem",
    "DecentralizedConstruction": "Lorem",
    "Dehumidifying": "Lorem",
    "Density": -18,
    "DriveEnergy": "Lorem",
    "ElectricalPower": -54,
    "EnergyEfficiencyClass": "Lorem",
    "EnergySupply": 54,
    "ExhaustAirVolumeFlow": 55,
    "ExtinguishingAgent": "Lorem",
    "FireClass": "Lorem",
    "FireExtinguisherTransportType": "Lorem",
    "FittingType": "Lorem",
    "Fuel": "Lorem",
    "GrateType": "Lorem",
    "HeatingType": "Lorem",
    "FilterClass": "Lorem",
    "Humidifying": "Lorem",
    "InstallationSite": "Lorem",
    "InstalledElectricalLoad": -51,
    "InsulationThickness": "Lorem",
    "MaximumBurnerCapacity": 39,
    "MaximumVolumeFlow": -69,
    "MinimumBurnerCapacity": 12,
    "MediumSupplied": "Lorem",
    "NominalPower": -24,
    "NumberOfAlarmValveStations": -81,
    "NumberOfCirculationPumps": 48,
    "NumberOfCompartmentValves": 2,
    "NumberOfHeatingCircuits": 41,
    "NumberOfCoolingCircuits": -83,
    "NumberOfInlets": 4,
    "NumberOfSprinklerHeads": 65,
    "NumberOfSupplyPoints": 79,
    "NumberOfZoneChecks": 5,
    "OperatingMode": "Lorem",
    "PipingSystem": "Lorem",
    "Power": 82,
    "PurposeOfHeating": "Lorem",
    "RadiatorType": "Lorem",
    "RecoolingSystemType": "Lorem",
    "RecoolingUnitType": "Lorem",
    "StorageColume": "Lorem",
    "ThearmalHeatingPower": -73,
    "ThermalPower": -70,
    "TraceHeating": "Lorem",
    "WaterSupply": "Lorem"
}
2.2.2.7 Document FProtectingObject
2.2.2.7.1 FProtectingObject Tree Diagram
2.2.2.7.2 FProtectingObject Properties
PropertyValue
Document nameFProtectingObject
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.7.3 FProtectingObject Fields
FieldTypeReqKeyDescriptionComments
FProtectingObjectIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

ProductIdstringfalse

Reference to the product which the emitting object belongs to

Typestringfalse
Classstringfalse
Namestringfalse
InstallationSituationstringfalse
ProofOfUsabilitystringfalse
2.2.2.7.3.1 Field FProtectingObjectId
2.2.2.7.3.1.1 FProtectingObjectId properties
PropertyValue
Name FProtectingObjectId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.7.3.2 Field ProductId
2.2.2.7.3.2.1 ProductId properties
PropertyValue
Name ProductId
Technical name
Activated true
Id
Type string
Description

Reference to the product which the emitting object belongs to

Dependencies
Required
Primary key false
Foreign collection Product
Foreign field ProductId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.7.3.3 Field Type
2.2.2.7.3.3.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.7.3.4 Field Class
2.2.2.7.3.4.1 Class properties
PropertyValue
Name Class
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.7.3.5 Field Name
2.2.2.7.3.5.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.7.3.6 Field InstallationSituation
2.2.2.7.3.6.1 InstallationSituation properties
PropertyValue
Name InstallationSituation
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.7.3.7 Field ProofOfUsability
2.2.2.7.3.7.1 ProofOfUsability properties
PropertyValue
Name ProofOfUsability
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.7.4 FProtectingObject JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "FProtectingObject",
    "additionalProperties": false,
    "properties": {
        "FProtectingObjectId": {
            "type": "string",
            "description": "Customer ID from previous system  (ID before onboarding data to BM)"
        },
        "ProductId": {
            "type": "string",
            "description": "Reference to the product which the emitting object belongs to"
        },
        "Type": {
            "type": "string"
        },
        "Class": {
            "type": "string"
        },
        "Name": {
            "type": "string"
        },
        "InstallationSituation": {
            "type": "string"
        },
        "ProofOfUsability": {
            "type": "string"
        }
    }
}
2.2.2.7.5 FProtectingObject JSON data
{
    "FProtectingObjectId": "Lorem",
    "ProductId": "Lorem",
    "Type": "Lorem",
    "Class": "Lorem",
    "Name": "Lorem",
    "InstallationSituation": "Lorem",
    "ProofOfUsability": "Lorem"
}
2.2.2.8 Document Floor
2.2.2.8.1 Floor Tree Diagram
2.2.2.8.2 Floor Properties
PropertyValue
Document nameFloor
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.8.3 Floor Fields
FieldTypeReqKeyDescriptionComments
FloorIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

FloorCodestringfalse

User specific Floor Code e.g: F003

Namestringfalse

Name of floor e.g: EG; 1st floor; UG

FloorNumbernumberfalse

Number of floor e.g: 4; 19

ValidFromstringfalse

Date area measurement was taken e.g: 10.10.20

[{"dataType":"dateTime"}]

ValidUntilstringtrue

Date area measurement need to be renewed e.g: 12.10.23

[{"dataType":"dateTime"}]

BuildingIdstringfalse

Reference to the Building which the Floor belongs to

Guidstringfalse

Globally Unique Identifier number

2.2.2.8.3.1 Field FloorId
2.2.2.8.3.1.1 FloorId properties
PropertyValue
Name FloorId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.8.3.2 Field FloorCode
2.2.2.8.3.2.1 FloorCode properties
PropertyValue
Name FloorCode
Technical name
Activated true
Id
Type string
Description

User specific Floor Code e.g: F003

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.8.3.3 Field Name
2.2.2.8.3.3.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description

Name of floor e.g: EG; 1st floor; UG

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.8.3.4 Field FloorNumber
2.2.2.8.3.4.1 FloorNumber properties
PropertyValue
Name FloorNumber
Technical name
Activated true
Id
Type number
Description

Number of floor e.g: 4; 19

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.8.3.5 Field ValidFrom
2.2.2.8.3.5.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name
Activated true
Id
Type string
Description

Date area measurement was taken e.g: 10.10.20

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.8.3.6 Field ValidUntil
2.2.2.8.3.6.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name
Activated true
Id
Type string
Description

Date area measurement need to be renewed e.g: 12.10.23

Dependencies
Required true
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.8.3.7 Field BuildingId
2.2.2.8.3.7.1 BuildingId properties
PropertyValue
Name BuildingId
Technical name Bldngd
Activated true
Id
Type string
Description

Reference to the Building which the Floor belongs to

Dependencies
Required
Primary key false
Foreign collection Building
Foreign field BuildingId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.8.3.8 Field Guid
2.2.2.8.3.8.1 Guid properties
PropertyValue
Name Guid
Technical name
Activated true
Id
Type string
Description

Globally Unique Identifier number

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.8.4 Floor JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Floor",
    "additionalProperties": false,
    "properties": {
        "FloorId": {
            "type": "string",
            "description": "Customer ID from previous system  (ID before onboarding data to BM)"
        },
        "FloorCode": {
            "type": "string",
            "description": "User specific Floor Code e.g: F003"
        },
        "Name": {
            "type": "string",
            "description": "Name of floor e.g: EG; 1st floor; UG"
        },
        "FloorNumber": {
            "type": "number",
            "description": "Number of floor e.g: 4; 19"
        },
        "ValidFrom": {
            "type": "string",
            "description": "Date area measurement was taken e.g: 10.10.20"
        },
        "ValidUntil": {
            "type": "string",
            "description": "Date area measurement need to be renewed e.g: 12.10.23 "
        },
        "Bldngd": {
            "type": "string",
            "description": "Reference to the Building which the Floor belongs to"
        },
        "Guid": {
            "type": "string",
            "description": "Globally Unique Identifier number"
        }
    },
    "required": [
        "ValidUntil"
    ]
}
2.2.2.8.5 Floor JSON data
{
    "FloorId": "Lorem",
    "FloorCode": "Lorem",
    "Name": "Lorem",
    "FloorNumber": 36,
    "ValidFrom": "Lorem",
    "ValidUntil": "Lorem",
    "Bldngd": "Lorem",
    "Guid": "Lorem"
}
2.2.2.9 Document GGeneratingObject
2.2.2.9.1 GGeneratingObject Tree Diagram
2.2.2.9.2 GGeneratingObject Properties
PropertyValue
Document nameGGeneratingObject
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.9.3 GGeneratingObject Fields
FieldTypeReqKeyDescriptionComments
GGeneratingObjectIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

ProductIdstringfalse

Reference to the product which the generating object belongs to

Typestringfalse
Classstringfalse
Namestringfalse
AutomaticFeedbooleanfalse
ApplicationAreastringfalse
Ceilingstringfalse
CompressorTypestringfalse
CollectingContainerstringfalse
ConstructionStandardsstringfalse
ContainerVolumenumberfalse

[{"dataType":"float"}]

ContainingFecesstringfalse
Directionstringfalse
DischargeHeightnumberfalse

[{"dataType":"float"}]

ElectricalPeaknumberfalse

[{"dataType":"float"}]

ElectricalPowernumberfalse

[{"dataType":"float"}]

ExplosionSafestringfalse
FanSeriesstringfalse
FlowRatenumberfalse

[{"dataType":"float"}]

LifterTypestringfalse
LiftingHeightnumberfalse

[{"dataType":"float"}]

Lightingstringfalse
LoadBearingCapacitynumberfalse

[{"dataType":"float"}]

MaximumPressurenumberfalse

[{"dataType":"float"}]

MobileSystemstringfalse
MotorNominalPowernumberfalse

[{"dataType":"float"}]

MotorPowernumberfalse

[{"dataType":"float"}]

MotorRatedCurrentnumberfalse

[{"dataType":"float"}]

NumberOfCellsnumberfalse

Number of cells

NumberOfDrivesnumberfalse

Number of drivers

NumberOfModulesnumberfalse

Number of modules

NumberOfPowerInvertersnumberfalse

Number of power inverters

NumberOfPumpsnumberfalse

Number of pumps

NumberOfStopsnumberfalse

Number of stops

NumberOfTappingnumberfalse

Number of tapping

OptimalVolumeStreamnumberfalse

[{"dataType":"float"}]

PassengerCapacitynumberfalse

Capacity of passengers

ProtectionTypestringfalse
RatedCapacitynumberfalse
Ratedstringfalse
RatedElectricalPowernumberfalse

[{"dataType":"float"}]

RotationSpeedControlnumberfalse

[{"dataType":"float"}]

RotorDiameternumberfalse

[{"dataType":"float"}]

SafeFallProtectionstringfalse
SpeedControlbooleanfalse
TiltingAnglenumberfalse

[{"dataType":"float"}]

Triggeringstringfalse
Voltagenumberfalse

[{"dataType":"float"}]

VolumeFlownumberfalse

[{"dataType":"float"}]

VolumeOfFuelReservesnumberfalse

[{"dataType":"float"}]

2.2.2.9.3.1 Field GGeneratingObjectId
2.2.2.9.3.1.1 GGeneratingObjectId properties
PropertyValue
Name GGeneratingObjectId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.2 Field ProductId
2.2.2.9.3.2.1 ProductId properties
PropertyValue
Name ProductId
Technical name
Activated true
Id
Type string
Description

Reference to the product which the generating object belongs to

Dependencies
Required
Primary key false
Foreign collection Product
Foreign field ProductId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.3 Field Type
2.2.2.9.3.3.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.4 Field Class
2.2.2.9.3.4.1 Class properties
PropertyValue
Name Class
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.5 Field Name
2.2.2.9.3.5.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.6 Field AutomaticFeed
2.2.2.9.3.6.1 AutomaticFeed properties
PropertyValue
Name AutomaticFeed
Technical name
Activated true
Id
Type boolean
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Sample
Comments
2.2.2.9.3.7 Field ApplicationArea
2.2.2.9.3.7.1 ApplicationArea properties
PropertyValue
Name ApplicationArea
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.8 Field Ceiling
2.2.2.9.3.8.1 Ceiling properties
PropertyValue
Name Ceiling
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.9 Field CompressorType
2.2.2.9.3.9.1 CompressorType properties
PropertyValue
Name CompressorType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.10 Field CollectingContainer
2.2.2.9.3.10.1 CollectingContainer properties
PropertyValue
Name CollectingContainer
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.11 Field ConstructionStandards
2.2.2.9.3.11.1 ConstructionStandards properties
PropertyValue
Name ConstructionStandards
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.12 Field ContainerVolume
2.2.2.9.3.12.1 ContainerVolume properties
PropertyValue
Name ContainerVolume
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.9.3.13 Field ContainingFeces
2.2.2.9.3.13.1 ContainingFeces properties
PropertyValue
Name ContainingFeces
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.14 Field Direction
2.2.2.9.3.14.1 Direction properties
PropertyValue
Name Direction
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.15 Field DischargeHeight
2.2.2.9.3.15.1 DischargeHeight properties
PropertyValue
Name DischargeHeight
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.9.3.16 Field ElectricalPeak
2.2.2.9.3.16.1 ElectricalPeak properties
PropertyValue
Name ElectricalPeak
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.9.3.17 Field ElectricalPower
2.2.2.9.3.17.1 ElectricalPower properties
PropertyValue
Name ElectricalPower
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.9.3.18 Field ExplosionSafe
2.2.2.9.3.18.1 ExplosionSafe properties
PropertyValue
Name ExplosionSafe
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.19 Field FanSeries
2.2.2.9.3.19.1 FanSeries properties
PropertyValue
Name FanSeries
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.20 Field FlowRate
2.2.2.9.3.20.1 FlowRate properties
PropertyValue
Name FlowRate
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.9.3.21 Field LifterType
2.2.2.9.3.21.1 LifterType properties
PropertyValue
Name LifterType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.22 Field LiftingHeight
2.2.2.9.3.22.1 LiftingHeight properties
PropertyValue
Name LiftingHeight
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.9.3.23 Field Lighting
2.2.2.9.3.23.1 Lighting properties
PropertyValue
Name Lighting
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.24 Field LoadBearingCapacity
2.2.2.9.3.24.1 LoadBearingCapacity properties
PropertyValue
Name LoadBearingCapacity
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.9.3.25 Field MaximumPressure
2.2.2.9.3.25.1 MaximumPressure properties
PropertyValue
Name MaximumPressure
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.9.3.26 Field MobileSystem
2.2.2.9.3.26.1 MobileSystem properties
PropertyValue
Name MobileSystem
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.27 Field MotorNominalPower
2.2.2.9.3.27.1 MotorNominalPower properties
PropertyValue
Name MotorNominalPower
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.9.3.28 Field MotorPower
2.2.2.9.3.28.1 MotorPower properties
PropertyValue
Name MotorPower
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.9.3.29 Field MotorRatedCurrent
2.2.2.9.3.29.1 MotorRatedCurrent properties
PropertyValue
Name MotorRatedCurrent
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.9.3.30 Field NumberOfCells
2.2.2.9.3.30.1 NumberOfCells properties
PropertyValue
Name NumberOfCells
Technical name
Activated true
Id
Type number
Description

Number of cells

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.9.3.31 Field NumberOfDrives
2.2.2.9.3.31.1 NumberOfDrives properties
PropertyValue
Name NumberOfDrives
Technical name
Activated true
Id
Type number
Description

Number of drivers

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.9.3.32 Field NumberOfModules
2.2.2.9.3.32.1 NumberOfModules properties
PropertyValue
Name NumberOfModules
Technical name
Activated true
Id
Type number
Description

Number of modules

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.9.3.33 Field NumberOfPowerInverters
2.2.2.9.3.33.1 NumberOfPowerInverters properties
PropertyValue
Name NumberOfPowerInverters
Technical name
Activated true
Id
Type number
Description

Number of power inverters

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.9.3.34 Field NumberOfPumps
2.2.2.9.3.34.1 NumberOfPumps properties
PropertyValue
Name NumberOfPumps
Technical name
Activated true
Id
Type number
Description

Number of pumps

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.9.3.35 Field NumberOfStops
2.2.2.9.3.35.1 NumberOfStops properties
PropertyValue
Name NumberOfStops
Technical name
Activated true
Id
Type number
Description

Number of stops

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.9.3.36 Field NumberOfTapping
2.2.2.9.3.36.1 NumberOfTapping properties
PropertyValue
Name NumberOfTapping
Technical name
Activated true
Id
Type number
Description

Number of tapping

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.9.3.37 Field OptimalVolumeStream
2.2.2.9.3.37.1 OptimalVolumeStream properties
PropertyValue
Name OptimalVolumeStream
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.9.3.38 Field PassengerCapacity
2.2.2.9.3.38.1 PassengerCapacity properties
PropertyValue
Name PassengerCapacity
Technical name
Activated true
Id
Type number
Description

Capacity of passengers

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.9.3.39 Field ProtectionType
2.2.2.9.3.39.1 ProtectionType properties
PropertyValue
Name ProtectionType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.40 Field RatedCapacity
2.2.2.9.3.40.1 RatedCapacity properties
PropertyValue
Name RatedCapacity
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.9.3.41 Field Rated
2.2.2.9.3.41.1 Rated properties
PropertyValue
Name Rated
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.42 Field RatedElectricalPower
2.2.2.9.3.42.1 RatedElectricalPower properties
PropertyValue
Name RatedElectricalPower
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.9.3.43 Field RotationSpeedControl
2.2.2.9.3.43.1 RotationSpeedControl properties
PropertyValue
Name RotationSpeedControl
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.9.3.44 Field RotorDiameter
2.2.2.9.3.44.1 RotorDiameter properties
PropertyValue
Name RotorDiameter
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.9.3.45 Field SafeFallProtection
2.2.2.9.3.45.1 SafeFallProtection properties
PropertyValue
Name SafeFallProtection
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.46 Field SpeedControl
2.2.2.9.3.46.1 SpeedControl properties
PropertyValue
Name SpeedControl
Technical name
Activated true
Id
Type boolean
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Sample
Comments
2.2.2.9.3.47 Field TiltingAngle
2.2.2.9.3.47.1 TiltingAngle properties
PropertyValue
Name TiltingAngle
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.9.3.48 Field Triggering
2.2.2.9.3.48.1 Triggering properties
PropertyValue
Name Triggering
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.9.3.49 Field Voltage
2.2.2.9.3.49.1 Voltage properties
PropertyValue
Name Voltage
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.9.3.50 Field VolumeFlow
2.2.2.9.3.50.1 VolumeFlow properties
PropertyValue
Name VolumeFlow
Technical name
Activated true
Id
Type number
Description

[{"dataType":"float"}]

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.9.3.51 Field VolumeOfFuelReserves
2.2.2.9.3.51.1 VolumeOfFuelReserves properties
PropertyValue
Name VolumeOfFuelReserves
Technical name
Activated true
Id
Type number
Description

[{"dataType":"float"}]

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.9.4 GGeneratingObject JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "GGeneratingObject",
    "additionalProperties": false,
    "properties": {
        "GGeneratingObjectId": {
            "type": "string",
            "description": "Customer ID from previous system  (ID before onboarding data to BM)"
        },
        "ProductId": {
            "type": "string",
            "description": "Reference to the product which the generating object belongs to"
        },
        "Type": {
            "type": "string"
        },
        "Class": {
            "type": "string"
        },
        "Name": {
            "type": "string"
        },
        "AutomaticFeed": {
            "type": "boolean"
        },
        "ApplicationArea": {
            "type": "string"
        },
        "Ceiling": {
            "type": "string"
        },
        "CompressorType": {
            "type": "string"
        },
        "CollectingContainer": {
            "type": "string"
        },
        "ConstructionStandards": {
            "type": "string"
        },
        "ContainerVolume": {
            "type": "number"
        },
        "ContainingFeces": {
            "type": "string"
        },
        "Direction": {
            "type": "string"
        },
        "DischargeHeight": {
            "type": "number"
        },
        "ElectricalPeak": {
            "type": "number"
        },
        "ElectricalPower": {
            "type": "number"
        },
        "ExplosionSafe": {
            "type": "string"
        },
        "FanSeries": {
            "type": "string"
        },
        "FlowRate": {
            "type": "number"
        },
        "LifterType": {
            "type": "string"
        },
        "LiftingHeight": {
            "type": "number"
        },
        "Lighting": {
            "type": "string"
        },
        "LoadBearingCapacity": {
            "type": "number"
        },
        "MaximumPressure": {
            "type": "number"
        },
        "MobileSystem": {
            "type": "string"
        },
        "MotorNominalPower": {
            "type": "number"
        },
        "MotorPower": {
            "type": "number"
        },
        "MotorRatedCurrent": {
            "type": "number"
        },
        "NumberOfCells": {
            "type": "number",
            "description": "Number of cells"
        },
        "NumberOfDrives": {
            "type": "number",
            "description": "Number of drivers"
        },
        "NumberOfModules": {
            "type": "number",
            "description": "Number of modules"
        },
        "NumberOfPowerInverters": {
            "type": "number",
            "description": "Number of power inverters"
        },
        "NumberOfPumps": {
            "type": "number",
            "description": "Number of pumps"
        },
        "NumberOfStops": {
            "type": "number",
            "description": "Number of stops"
        },
        "NumberOfTapping": {
            "type": "number",
            "description": "Number of tapping"
        },
        "OptimalVolumeStream": {
            "type": "number"
        },
        "PassengerCapacity": {
            "type": "number",
            "description": "Capacity of passengers"
        },
        "ProtectionType": {
            "type": "string"
        },
        "RatedCapacity": {
            "type": "number"
        },
        "Rated": {
            "type": "string"
        },
        "RatedElectricalPower": {
            "type": "number"
        },
        "RotationSpeedControl": {
            "type": "number"
        },
        "RotorDiameter": {
            "type": "number"
        },
        "SafeFallProtection": {
            "type": "string"
        },
        "SpeedControl": {
            "type": "boolean"
        },
        "TiltingAngle": {
            "type": "number"
        },
        "Triggering": {
            "type": "string"
        },
        "Voltage": {
            "type": "number"
        },
        "VolumeFlow": {
            "type": "number",
            "description": "[{\"dataType\":\"float\"}]"
        },
        "VolumeOfFuelReserves": {
            "type": "number",
            "description": "[{\"dataType\":\"float\"}]"
        }
    }
}
2.2.2.9.5 GGeneratingObject JSON data
{
    "GGeneratingObjectId": "Lorem",
    "ProductId": "Lorem",
    "Type": "Lorem",
    "Class": "Lorem",
    "Name": "Lorem",
    "AutomaticFeed": true,
    "ApplicationArea": "Lorem",
    "Ceiling": "Lorem",
    "CompressorType": "Lorem",
    "CollectingContainer": "Lorem",
    "ConstructionStandards": "Lorem",
    "ContainerVolume": 26,
    "ContainingFeces": "Lorem",
    "Direction": "Lorem",
    "DischargeHeight": -26,
    "ElectricalPeak": 75,
    "ElectricalPower": 22,
    "ExplosionSafe": "Lorem",
    "FanSeries": "Lorem",
    "FlowRate": -59,
    "LifterType": "Lorem",
    "LiftingHeight": -2,
    "Lighting": "Lorem",
    "LoadBearingCapacity": 31,
    "MaximumPressure": -90,
    "MobileSystem": "Lorem",
    "MotorNominalPower": -65,
    "MotorPower": 48,
    "MotorRatedCurrent": -69,
    "NumberOfCells": -14,
    "NumberOfDrives": 23,
    "NumberOfModules": -37,
    "NumberOfPowerInverters": 45,
    "NumberOfPumps": -44,
    "NumberOfStops": -2,
    "NumberOfTapping": -9,
    "OptimalVolumeStream": -62,
    "PassengerCapacity": 25,
    "ProtectionType": "Lorem",
    "RatedCapacity": -38,
    "Rated": "Lorem",
    "RatedElectricalPower": 71,
    "RotationSpeedControl": -16,
    "RotorDiameter": 47,
    "SafeFallProtection": "Lorem",
    "SpeedControl": true,
    "TiltingAngle": -49,
    "Triggering": "Lorem",
    "Voltage": -7,
    "VolumeFlow": 64,
    "VolumeOfFuelReserves": -69
}
2.2.2.10 Document HMatterProcessingObject
2.2.2.10.1 HMatterProcessingObject Tree Diagram
2.2.2.10.2 HMatterProcessingObject Properties
PropertyValue
Document nameHMatterProcessingObject
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.10.3 HMatterProcessingObject Fields
FieldTypeReqKeyDescriptionComments
HMatterProcessingObjectIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

ProductIdstringfalse

Reference to the product which the matter processing object belongs to

Typestringfalse
Classstringfalse
ThermalPowerstringfalse
TypeOfUsestringfalse
AbsorberAreanumberfalse

[{"dataType":"float"}]

AirFilterTypestringfalse
Backwashablestringfalse
EnergyEfficiencyClassstringfalse
2.2.2.10.3.1 Field HMatterProcessingObjectId
2.2.2.10.3.1.1 HMatterProcessingObjectId properties
PropertyValue
Name HMatterProcessingObjectId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.10.3.2 Field ProductId
2.2.2.10.3.2.1 ProductId properties
PropertyValue
Name ProductId
Technical name
Activated true
Id
Type string
Description

Reference to the product which the matter processing object belongs to

Dependencies
Required
Primary key false
Foreign collection Product
Foreign field ProductId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.10.3.3 Field Type
2.2.2.10.3.3.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.10.3.4 Field Class
2.2.2.10.3.4.1 Class properties
PropertyValue
Name Class
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.10.3.5 Field ThermalPower
2.2.2.10.3.5.1 ThermalPower properties
PropertyValue
Name ThermalPower
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.10.3.6 Field TypeOfUse
2.2.2.10.3.6.1 TypeOfUse properties
PropertyValue
Name TypeOfUse
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.10.3.7 Field AbsorberArea
2.2.2.10.3.7.1 AbsorberArea properties
PropertyValue
Name AbsorberArea
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.10.3.8 Field AirFilterType
2.2.2.10.3.8.1 AirFilterType properties
PropertyValue
Name AirFilterType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.10.3.9 Field Backwashable
2.2.2.10.3.9.1 Backwashable properties
PropertyValue
Name Backwashable
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.10.3.10 Field EnergyEfficiencyClass
2.2.2.10.3.10.1 EnergyEfficiencyClass properties
PropertyValue
Name EnergyEfficiencyClass
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.10.4 HMatterProcessingObject JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "HMatterProcessingObject",
    "additionalProperties": false,
    "properties": {
        "HMatterProcessingObjectId": {
            "type": "string",
            "description": "Customer ID from previous system  (ID before onboarding data to BM)"
        },
        "ProductId": {
            "type": "string",
            "description": "Reference to the product which the matter processing object belongs to"
        },
        "Type": {
            "type": "string"
        },
        "Class": {
            "type": "string"
        },
        "ThermalPower": {
            "type": "string"
        },
        "TypeOfUse": {
            "type": "string"
        },
        "AbsorberArea": {
            "type": "number"
        },
        "AirFilterType": {
            "type": "string"
        },
        "Backwashable": {
            "type": "string"
        },
        "EnergyEfficiencyClass": {
            "type": "string"
        }
    }
}
2.2.2.10.5 HMatterProcessingObject JSON data
{
    "HMatterProcessingObjectId": "Lorem",
    "ProductId": "Lorem",
    "Type": "Lorem",
    "Class": "Lorem",
    "ThermalPower": "Lorem",
    "TypeOfUse": "Lorem",
    "AbsorberArea": -12,
    "AirFilterType": "Lorem",
    "Backwashable": "Lorem",
    "EnergyEfficiencyClass": "Lorem"
}
2.2.2.11 Document Land
2.2.2.11.1 Land Tree Diagram
2.2.2.11.2 Land Properties
PropertyValue
Document nameLand
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.11.3 Land Fields
FieldTypeReqKeyDescriptionComments
LandIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

Typestringfalse

Type of land e.g: agricultural, recreational, industrial, non-industrial, traffic

New Fieldstringfalse

Development level of land e.g: full/partial/non

ParcelNrnumberfalse

District/Zoning registered number for the Plot of land

LandCodenumberfalse

Code representing country

ValidFromstringfalse

Date land was recorded e.g: 10.10.20

[{"dataType":"dateTime"}]

ValidUntilstringfalse

Date land is not valid anymore /needs to be checked

[{"dataType":"dateTime"}]

Namestringfalse

Name of Land e.g: park, garden, parking

SiteIdstringfalse

Reference to the site which the land belongs to

GeorefIdstringfalse

A reference to Guid from the geo-coordinate entity

Guidstringfalse

Globally Unique Identifier number

2.2.2.11.3.1 Field LandId
2.2.2.11.3.1.1 LandId properties
PropertyValue
Name LandId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

Customer ID from previous system (ID before onboarding data to BM)

2.2.2.11.3.2 Field Type
2.2.2.11.3.2.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description

Type of land e.g: agricultural, recreational, industrial, non-industrial, traffic

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.11.3.3 Field New Field
2.2.2.11.3.3.1 New Field properties
PropertyValue
Name New Field
Technical name
Activated true
Id
Type string
Description

Development level of land e.g: full/partial/non

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.11.3.4 Field ParcelNr
2.2.2.11.3.4.1 ParcelNr properties
PropertyValue
Name ParcelNr
Technical name
Activated true
Id
Type number
Description

District/Zoning registered number for the Plot of land

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.11.3.5 Field LandCode
2.2.2.11.3.5.1 LandCode properties
PropertyValue
Name LandCode
Technical name
Activated true
Id
Type number
Description

Code representing country

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.11.3.6 Field ValidFrom
2.2.2.11.3.6.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name
Activated true
Id
Type string
Description

Date land was recorded e.g: 10.10.20

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.11.3.7 Field ValidUntil
2.2.2.11.3.7.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name
Activated true
Id
Type string
Description

Date land is not valid anymore /needs to be checked

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.11.3.8 Field Name
2.2.2.11.3.8.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description

Name of Land e.g: park, garden, parking

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.11.3.9 Field SiteId
2.2.2.11.3.9.1 SiteId properties
PropertyValue
Name SiteId
Technical name Std
Activated true
Id
Type string
Description

Reference to the site which the land belongs to

Dependencies
Required
Primary key false
Foreign collection Site
Foreign field SiteId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.11.3.10 Field GeorefId
2.2.2.11.3.10.1 GeorefId properties
PropertyValue
Name GeorefId
Technical name
Activated true
Id
Type string
Description

A reference to Guid from the geo-coordinate entity

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.11.3.11 Field Guid
2.2.2.11.3.11.1 Guid properties
PropertyValue
Name Guid
Technical name
Activated true
Id
Type string
Description

Globally Unique Identifier number

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.11.4 Land JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Land",
    "additionalProperties": false,
    "properties": {
        "LandId": {
            "type": "string"
        },
        "Type": {
            "type": "string",
            "description": "Type of land e.g: agricultural, recreational, industrial, non-industrial, traffic"
        },
        "New Field": {
            "type": "string",
            "description": "Development level of land e.g: full/partial/non"
        },
        "ParcelNr": {
            "type": "number",
            "description": "District/Zoning registered number for the Plot of land"
        },
        "LandCode": {
            "type": "number",
            "description": "Code representing country"
        },
        "ValidFrom": {
            "type": "string",
            "description": "Date land was recorded e.g: 10.10.20"
        },
        "ValidUntil": {
            "type": "string",
            "description": "Date land is not valid anymore /needs to be checked"
        },
        "Name": {
            "type": "string",
            "description": "Name of Land e.g: park, garden, parking"
        },
        "Std": {
            "type": "string",
            "description": "Reference to the site which the land belongs to"
        },
        "GeorefId": {
            "type": "string",
            "description": "A reference to Guid from the geo-coordinate entity"
        },
        "Guid": {
            "type": "string",
            "description": "Globally Unique Identifier number"
        }
    }
}
2.2.2.11.5 Land JSON data
{
    "LandId": "Lorem",
    "Type": "Lorem",
    "New Field": "Lorem",
    "ParcelNr": -92,
    "LandCode": -97,
    "ValidFrom": "Lorem",
    "ValidUntil": "Lorem",
    "Name": "Lorem",
    "Std": "Lorem",
    "GeorefId": "Lorem",
    "Guid": "Lorem"
}
2.2.2.12 Document MDrivingObject
2.2.2.12.1 MDrivingObject Tree Diagram
2.2.2.12.2 MDrivingObject Properties
PropertyValue
Document nameMDrivingObject
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.12.3 MDrivingObject Fields
FieldTypeReqKeyDescriptionComments
MDrivingObjectIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

ProductIdstringfalse

Reference to the product which the driving object belongs to

Typestringfalse
Classstringfalse
Fuelstringfalse
MotorNominalPowernumberfalse

[{"dataType":"float"}]

NominalThermalPowernumberfalse

[{"dataType":"float"}]

ExplosionSafebooleanfalse
OperatingModestringfalse
RatedElectricalPowernumberfalse

[{"dataType":"float"}]

Voltagenumberfalse

[{"dataType":"float"}]

2.2.2.12.3.1 Field MDrivingObjectId
2.2.2.12.3.1.1 MDrivingObjectId properties
PropertyValue
Name MDrivingObjectId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.12.3.2 Field ProductId
2.2.2.12.3.2.1 ProductId properties
PropertyValue
Name ProductId
Technical name
Activated true
Id
Type string
Description

Reference to the product which the driving object belongs to

Dependencies
Required
Primary key false
Foreign collection Product
Foreign field ProductId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.12.3.3 Field Type
2.2.2.12.3.3.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.12.3.4 Field Class
2.2.2.12.3.4.1 Class properties
PropertyValue
Name Class
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.12.3.5 Field Fuel
2.2.2.12.3.5.1 Fuel properties
PropertyValue
Name Fuel
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.12.3.6 Field MotorNominalPower
2.2.2.12.3.6.1 MotorNominalPower properties
PropertyValue
Name MotorNominalPower
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.12.3.7 Field NominalThermalPower
2.2.2.12.3.7.1 NominalThermalPower properties
PropertyValue
Name NominalThermalPower
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.12.3.8 Field ExplosionSafe
2.2.2.12.3.8.1 ExplosionSafe properties
PropertyValue
Name ExplosionSafe
Technical name
Activated true
Id
Type boolean
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Sample
Comments
2.2.2.12.3.9 Field OperatingMode
2.2.2.12.3.9.1 OperatingMode properties
PropertyValue
Name OperatingMode
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.12.3.10 Field RatedElectricalPower
2.2.2.12.3.10.1 RatedElectricalPower properties
PropertyValue
Name RatedElectricalPower
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.12.3.11 Field Voltage
2.2.2.12.3.11.1 Voltage properties
PropertyValue
Name Voltage
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.12.4 MDrivingObject JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "MDrivingObject",
    "additionalProperties": false,
    "properties": {
        "MDrivingObjectId": {
            "type": "string",
            "description": "Customer ID from previous system  (ID before onboarding data to BM)"
        },
        "ProductId": {
            "type": "string",
            "description": "Reference to the product which the driving object belongs to"
        },
        "Type": {
            "type": "string"
        },
        "Class": {
            "type": "string"
        },
        "Fuel": {
            "type": "string"
        },
        "MotorNominalPower": {
            "type": "number"
        },
        "NominalThermalPower": {
            "type": "number"
        },
        "ExplosionSafe": {
            "type": "boolean"
        },
        "OperatingMode": {
            "type": "string"
        },
        "RatedElectricalPower": {
            "type": "number"
        },
        "Voltage": {
            "type": "number"
        }
    }
}
2.2.2.12.5 MDrivingObject JSON data
{
    "MDrivingObjectId": "Lorem",
    "ProductId": "Lorem",
    "Type": "Lorem",
    "Class": "Lorem",
    "Fuel": "Lorem",
    "MotorNominalPower": 79,
    "NominalThermalPower": 34,
    "ExplosionSafe": true,
    "OperatingMode": "Lorem",
    "RatedElectricalPower": 59,
    "Voltage": 34
}
2.2.2.13 Document Product
2.2.2.13.1 Product Tree Diagram
2.2.2.13.2 Product Properties
PropertyValue
Document nameProduct
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.13.3 Product Fields
FieldTypeReqKeyDescriptionComments
ProductIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

Namestringfalse

Name of product e.g: Brandschutztür, Fire extinguisher

Descriptionstringfalse

Description of Product

Classstringfalse

Class product belomgs to e.g: 344.10 Interior Doors

Typestringfalse

Type of product e.g: equipment

ValidFromstringfalse

Date product was installed e.g: 29.10.19

[{"dataType":"dateTime"}]

ValidUntilstringfalse

Date product needs to be renewed e.g: 30.11.21

[{"dataType":"dateTime"}]

GuaranteeEndstringfalse

End date of guarantee

[{"dataType":"dateTime"}]

LifeSpanYearnumberfalse

Life span of product e.g: 30 years

ConditionStatusstringfalse

Condition of product e.g: poor, very good

MaintenanceGroupstringfalse

Maintenance group of product

MaintenanceRelevancestringfalse

Relevance of maintenance e.g: high, important

EquipmentDimensionstringfalse

Height, width and depth of product

ProductNamestringfalse

Manufacturer Name e.g: T-30-1-Klappe

ProductCodestringfalse

Product specific code (from producer)

ProductTypestringfalse

Manufacturer Type e.g: Brandschutztür

URLLibrarystringfalse

Product website

ProducerCodestringfalse

Name of producer/manufacturer e.g: Celler Eisenbau

SupplierCodestringfalse

Name of supplier (if different supplier than producer)

Yearstringfalse

Year product was manufactured e.g: 2020

[{"dataType":"dateTime"}]

SerialNumberstringfalse

Serial number of product e.g: xan51425612

CE-Identificationstringfalse

European identification number

DeliveryVolumenumberfalse

[{"dataType":"float"}]

ContentQuantitynumberfalse

Number of products included in one order

NetContentnumberfalse
Payloadnumberfalse

Payload of Product

SpaceIdstringfalse

Reference to the Space which the Equipment belongs to

BusinessPartnerIdstringfalse

Reference to the business partner

Guidstringfalse

Globally Unique Identifier number

2.2.2.13.3.1 Field ProductId
2.2.2.13.3.1.1 ProductId properties
PropertyValue
Name ProductId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.2 Field Name
2.2.2.13.3.2.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description

Name of product e.g: Brandschutztür, Fire extinguisher

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.3 Field Description
2.2.2.13.3.3.1 Description properties
PropertyValue
Name Description
Technical name
Activated true
Id
Type string
Description

Description of Product

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.4 Field Class
2.2.2.13.3.4.1 Class properties
PropertyValue
Name Class
Technical name
Activated true
Id
Type string
Description

Class product belomgs to e.g: 344.10 Interior Doors

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.5 Field Type
2.2.2.13.3.5.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description

Type of product e.g: equipment

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.6 Field ValidFrom
2.2.2.13.3.6.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name
Activated true
Id
Type string
Description

Date product was installed e.g: 29.10.19

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.13.3.7 Field ValidUntil
2.2.2.13.3.7.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name
Activated true
Id
Type string
Description

Date product needs to be renewed e.g: 30.11.21

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.13.3.8 Field GuaranteeEnd
2.2.2.13.3.8.1 GuaranteeEnd properties
PropertyValue
Name GuaranteeEnd
Technical name
Activated true
Id
Type string
Description

End date of guarantee

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.13.3.9 Field LifeSpanYear
2.2.2.13.3.9.1 LifeSpanYear properties
PropertyValue
Name LifeSpanYear
Technical name
Activated true
Id
Type number
Description

Life span of product e.g: 30 years

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.13.3.10 Field ConditionStatus
2.2.2.13.3.10.1 ConditionStatus properties
PropertyValue
Name ConditionStatus
Technical name
Activated true
Id
Type string
Description

Condition of product e.g: poor, very good

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.11 Field MaintenanceGroup
2.2.2.13.3.11.1 MaintenanceGroup properties
PropertyValue
Name MaintenanceGroup
Technical name
Activated true
Id
Type string
Description

Maintenance group of product

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.12 Field MaintenanceRelevance
2.2.2.13.3.12.1 MaintenanceRelevance properties
PropertyValue
Name MaintenanceRelevance
Technical name
Activated true
Id
Type string
Description

Relevance of maintenance e.g: high, important

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.13 Field EquipmentDimension
2.2.2.13.3.13.1 EquipmentDimension properties
PropertyValue
Name EquipmentDimension
Technical name
Activated true
Id
Type string
Description

Height, width and depth of product

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.14 Field ProductName
2.2.2.13.3.14.1 ProductName properties
PropertyValue
Name ProductName
Technical name
Activated true
Id
Type string
Description

Manufacturer Name e.g: T-30-1-Klappe

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.15 Field ProductCode
2.2.2.13.3.15.1 ProductCode properties
PropertyValue
Name ProductCode
Technical name
Activated true
Id
Type string
Description

Product specific code (from producer)

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.16 Field ProductType
2.2.2.13.3.16.1 ProductType properties
PropertyValue
Name ProductType
Technical name
Activated true
Id
Type string
Description

Manufacturer Type e.g: Brandschutztür

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.17 Field URLLibrary
2.2.2.13.3.17.1 URLLibrary properties
PropertyValue
Name URLLibrary
Technical name
Activated true
Id
Type string
Description

Product website

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.18 Field ProducerCode
2.2.2.13.3.18.1 ProducerCode properties
PropertyValue
Name ProducerCode
Technical name
Activated true
Id
Type string
Description

Name of producer/manufacturer e.g: Celler Eisenbau

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.19 Field SupplierCode
2.2.2.13.3.19.1 SupplierCode properties
PropertyValue
Name SupplierCode
Technical name
Activated true
Id
Type string
Description

Name of supplier (if different supplier than producer)

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.20 Field Year
2.2.2.13.3.20.1 Year properties
PropertyValue
Name Year
Technical name
Activated true
Id
Type string
Description

Year product was manufactured e.g: 2020

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.13.3.21 Field SerialNumber
2.2.2.13.3.21.1 SerialNumber properties
PropertyValue
Name SerialNumber
Technical name
Activated true
Id
Type string
Description

Serial number of product e.g: xan51425612

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.22 Field CE-Identification
2.2.2.13.3.22.1 CE-Identification properties
PropertyValue
Name CE-Identification
Technical name
Activated true
Id
Type string
Description

European identification number

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.23 Field DeliveryVolume
2.2.2.13.3.23.1 DeliveryVolume properties
PropertyValue
Name DeliveryVolume
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.13.3.24 Field ContentQuantity
2.2.2.13.3.24.1 ContentQuantity properties
PropertyValue
Name ContentQuantity
Technical name
Activated true
Id
Type number
Description

Number of products included in one order

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.13.3.25 Field NetContent
2.2.2.13.3.25.1 NetContent properties
PropertyValue
Name NetContent
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.13.3.26 Field Payload
2.2.2.13.3.26.1 Payload properties
PropertyValue
Name Payload
Technical name
Activated true
Id
Type number
Description

Payload of Product

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.13.3.27 Field SpaceId
2.2.2.13.3.27.1 SpaceId properties
PropertyValue
Name SpaceId
Technical name Spcd
Activated true
Id
Type string
Description

Reference to the Space which the Equipment belongs to

Dependencies
Required
Primary key false
Foreign collection Space
Foreign field SpaceId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.28 Field BusinessPartnerId
2.2.2.13.3.28.1 BusinessPartnerId properties
PropertyValue
Name BusinessPartnerId
Technical name BsnssPrtnrd
Activated true
Id
Type string
Description

Reference to the business partner

Dependencies
Required
Primary key false
Foreign collection BusinessPartner
Foreign field BusinessPartnerId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.3.29 Field Guid
2.2.2.13.3.29.1 Guid properties
PropertyValue
Name Guid
Technical name
Activated true
Id
Type string
Description

Globally Unique Identifier number

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.13.4 Product JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Product",
    "additionalProperties": false,
    "properties": {
        "ProductId": {
            "type": "string",
            "description": "Customer ID from previous system  (ID before onboarding data to BM)"
        },
        "Name": {
            "type": "string",
            "description": "Name of product e.g: Brandschutztür, Fire extinguisher"
        },
        "Description": {
            "type": "string",
            "description": "Description of Product"
        },
        "Class": {
            "type": "string",
            "description": "Class product belomgs to e.g: 344.10 Interior Doors"
        },
        "Type": {
            "type": "string",
            "description": "Type of product e.g: equipment"
        },
        "ValidFrom": {
            "type": "string",
            "description": "Date product was installed e.g: 29.10.19"
        },
        "ValidUntil": {
            "type": "string",
            "description": "Date product needs to be renewed e.g: 30.11.21"
        },
        "GuaranteeEnd": {
            "type": "string",
            "description": "End date of guarantee"
        },
        "LifeSpanYear": {
            "type": "number",
            "description": "Life span of product e.g: 30 years"
        },
        "ConditionStatus": {
            "type": "string",
            "description": "Condition of product e.g: poor, very good"
        },
        "MaintenanceGroup": {
            "type": "string",
            "description": "Maintenance group of product"
        },
        "MaintenanceRelevance": {
            "type": "string",
            "description": "Relevance of maintenance e.g: high, important"
        },
        "EquipmentDimension": {
            "type": "string",
            "description": "Height, width and depth of product"
        },
        "ProductName": {
            "type": "string",
            "description": "Manufacturer Name e.g: T-30-1-Klappe"
        },
        "ProductCode": {
            "type": "string",
            "description": "Product specific code (from producer)"
        },
        "ProductType": {
            "type": "string",
            "description": "Manufacturer Type e.g: Brandschutztür"
        },
        "URLLibrary": {
            "type": "string",
            "description": "Product website"
        },
        "ProducerCode": {
            "type": "string",
            "description": "Name of producer/manufacturer e.g: Celler Eisenbau"
        },
        "SupplierCode": {
            "type": "string",
            "description": "Name of supplier (if different supplier than producer)"
        },
        "Year": {
            "type": "string",
            "description": "Year product was manufactured e.g: 2020"
        },
        "SerialNumber": {
            "type": "string",
            "description": "Serial number of product e.g: xan51425612"
        },
        "CE-Identification": {
            "type": "string",
            "description": "European identification number"
        },
        "DeliveryVolume": {
            "type": "number"
        },
        "ContentQuantity": {
            "type": "number",
            "description": "Number of products included in one order"
        },
        "NetContent": {
            "type": "number"
        },
        "Payload": {
            "type": "number",
            "description": "Payload of Product"
        },
        "Spcd": {
            "type": "string",
            "description": "Reference to the Space which the Equipment belongs to"
        },
        "BsnssPrtnrd": {
            "type": "string",
            "description": "Reference to the business partner"
        },
        "Guid": {
            "type": "string",
            "description": "Globally Unique Identifier number"
        }
    }
}
2.2.2.13.5 Product JSON data
{
    "ProductId": "Lorem",
    "Name": "Lorem",
    "Description": "Lorem",
    "Class": "Lorem",
    "Type": "Lorem",
    "ValidFrom": "Lorem",
    "ValidUntil": "Lorem",
    "GuaranteeEnd": "Lorem",
    "LifeSpanYear": 39,
    "ConditionStatus": "Lorem",
    "MaintenanceGroup": "Lorem",
    "MaintenanceRelevance": "Lorem",
    "EquipmentDimension": "Lorem",
    "ProductName": "Lorem",
    "ProductCode": "Lorem",
    "ProductType": "Lorem",
    "URLLibrary": "Lorem",
    "ProducerCode": "Lorem",
    "SupplierCode": "Lorem",
    "Year": "Lorem",
    "SerialNumber": "Lorem",
    "CE-Identification": "Lorem",
    "DeliveryVolume": -65,
    "ContentQuantity": -7,
    "NetContent": 23,
    "Payload": -10,
    "Spcd": "Lorem",
    "BsnssPrtnrd": "Lorem",
    "Guid": "Lorem"
}
2.2.2.14 Document QControllingObject
2.2.2.14.1 QControllingObject Tree Diagram
2.2.2.14.2 QControllingObject Properties
PropertyValue
Document nameQControllingObject
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.14.3 QControllingObject Fields
FieldTypeReqKeyDescriptionComments
QControllingObjectIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

ProductIdstringfalse

Reference to the product which the controlling object belongs to

Typestringfalse
Classstringfalse
AutomaticDrivebooleanfalse
SafetyRequirementsstringfalse
DriveManufacturerstringfalse
EmergencyExitLockstringfalse
FireResistanceClassstringfalse
FittingTypestringfalse
FixingSystemstringfalse
FrameSurfacestringfalse
GlassSurfacestringfalse
GateSafetyRequirementsstringfalse
LockingDevicestringfalse
OpeningTypestringfalse
ReadingSystemstringfalse
TypeOfGatestringfalse
TypeOfGateControlstringfalse
ClosingSystemstringfalse
NumberOfDrivesnumberfalse

Number of drives

NumberOfPanelsnumberfalse

Number of panels

NumberOfTranspondersnumberfalse

Number of transponders

2.2.2.14.3.1 Field QControllingObjectId
2.2.2.14.3.1.1 QControllingObjectId properties
PropertyValue
Name QControllingObjectId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.2 Field ProductId
2.2.2.14.3.2.1 ProductId properties
PropertyValue
Name ProductId
Technical name
Activated true
Id
Type string
Description

Reference to the product which the controlling object belongs to

Dependencies
Required
Primary key false
Foreign collection Product
Foreign field ProductId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.3 Field Type
2.2.2.14.3.3.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.4 Field Class
2.2.2.14.3.4.1 Class properties
PropertyValue
Name Class
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.5 Field AutomaticDrive
2.2.2.14.3.5.1 AutomaticDrive properties
PropertyValue
Name AutomaticDrive
Technical name
Activated true
Id
Type boolean
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Sample
Comments
2.2.2.14.3.6 Field SafetyRequirements
2.2.2.14.3.6.1 SafetyRequirements properties
PropertyValue
Name SafetyRequirements
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.7 Field DriveManufacturer
2.2.2.14.3.7.1 DriveManufacturer properties
PropertyValue
Name DriveManufacturer
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.8 Field EmergencyExitLock
2.2.2.14.3.8.1 EmergencyExitLock properties
PropertyValue
Name EmergencyExitLock
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.9 Field FireResistanceClass
2.2.2.14.3.9.1 FireResistanceClass properties
PropertyValue
Name FireResistanceClass
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.10 Field FittingType
2.2.2.14.3.10.1 FittingType properties
PropertyValue
Name FittingType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.11 Field FixingSystem
2.2.2.14.3.11.1 FixingSystem properties
PropertyValue
Name FixingSystem
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.12 Field FrameSurface
2.2.2.14.3.12.1 FrameSurface properties
PropertyValue
Name FrameSurface
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.13 Field GlassSurface
2.2.2.14.3.13.1 GlassSurface properties
PropertyValue
Name GlassSurface
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.14 Field GateSafetyRequirements
2.2.2.14.3.14.1 GateSafetyRequirements properties
PropertyValue
Name GateSafetyRequirements
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.15 Field LockingDevice
2.2.2.14.3.15.1 LockingDevice properties
PropertyValue
Name LockingDevice
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.16 Field OpeningType
2.2.2.14.3.16.1 OpeningType properties
PropertyValue
Name OpeningType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.17 Field ReadingSystem
2.2.2.14.3.17.1 ReadingSystem properties
PropertyValue
Name ReadingSystem
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.18 Field TypeOfGate
2.2.2.14.3.18.1 TypeOfGate properties
PropertyValue
Name TypeOfGate
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.19 Field TypeOfGateControl
2.2.2.14.3.19.1 TypeOfGateControl properties
PropertyValue
Name TypeOfGateControl
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.20 Field ClosingSystem
2.2.2.14.3.20.1 ClosingSystem properties
PropertyValue
Name ClosingSystem
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.14.3.21 Field NumberOfDrives
2.2.2.14.3.21.1 NumberOfDrives properties
PropertyValue
Name NumberOfDrives
Technical name
Activated true
Id
Type number
Description

Number of drives

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.14.3.22 Field NumberOfPanels
2.2.2.14.3.22.1 NumberOfPanels properties
PropertyValue
Name NumberOfPanels
Technical name
Activated true
Id
Type number
Description

Number of panels

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.14.3.23 Field NumberOfTransponders
2.2.2.14.3.23.1 NumberOfTransponders properties
PropertyValue
Name NumberOfTransponders
Technical name
Activated true
Id
Type number
Description

Number of transponders

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.14.4 QControllingObject JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "QControllingObject",
    "additionalProperties": false,
    "properties": {
        "QControllingObjectId": {
            "type": "string",
            "description": "Customer ID from previous system  (ID before onboarding data to BM)"
        },
        "ProductId": {
            "type": "string",
            "description": "Reference to the product which the controlling object belongs to"
        },
        "Type": {
            "type": "string"
        },
        "Class": {
            "type": "string"
        },
        "AutomaticDrive": {
            "type": "boolean"
        },
        "SafetyRequirements": {
            "type": "string"
        },
        "DriveManufacturer": {
            "type": "string"
        },
        "EmergencyExitLock": {
            "type": "string"
        },
        "FireResistanceClass": {
            "type": "string"
        },
        "FittingType": {
            "type": "string"
        },
        "FixingSystem": {
            "type": "string"
        },
        "FrameSurface": {
            "type": "string"
        },
        "GlassSurface": {
            "type": "string"
        },
        "GateSafetyRequirements": {
            "type": "string"
        },
        "LockingDevice": {
            "type": "string"
        },
        "OpeningType": {
            "type": "string"
        },
        "ReadingSystem": {
            "type": "string"
        },
        "TypeOfGate": {
            "type": "string"
        },
        "TypeOfGateControl": {
            "type": "string"
        },
        "ClosingSystem": {
            "type": "string"
        },
        "NumberOfDrives": {
            "type": "number",
            "description": "Number of drives"
        },
        "NumberOfPanels": {
            "type": "number",
            "description": "Number of panels"
        },
        "NumberOfTransponders": {
            "type": "number",
            "description": "Number of transponders"
        }
    }
}
2.2.2.14.5 QControllingObject JSON data
{
    "QControllingObjectId": "Lorem",
    "ProductId": "Lorem",
    "Type": "Lorem",
    "Class": "Lorem",
    "AutomaticDrive": true,
    "SafetyRequirements": "Lorem",
    "DriveManufacturer": "Lorem",
    "EmergencyExitLock": "Lorem",
    "FireResistanceClass": "Lorem",
    "FittingType": "Lorem",
    "FixingSystem": "Lorem",
    "FrameSurface": "Lorem",
    "GlassSurface": "Lorem",
    "GateSafetyRequirements": "Lorem",
    "LockingDevice": "Lorem",
    "OpeningType": "Lorem",
    "ReadingSystem": "Lorem",
    "TypeOfGate": "Lorem",
    "TypeOfGateControl": "Lorem",
    "ClosingSystem": "Lorem",
    "NumberOfDrives": -29,
    "NumberOfPanels": -10,
    "NumberOfTransponders": -53
}
2.2.2.15 Document RRestrictingObject
2.2.2.15.1 RRestrictingObject Tree Diagram
2.2.2.15.2 RRestrictingObject Properties
PropertyValue
Document nameRRestrictingObject
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.15.3 RRestrictingObject Fields
FieldTypeReqKeyDescriptionComments
RRestrictingObjectIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

ProductIdstringfalse

Reference to the product which the restricting object belongs to

Typestringfalse
Classstringfalse
AutomaticDrivebooleanfalse
NumberOfDrivesnumberfalse

Number of drives

2.2.2.15.3.1 Field RRestrictingObjectId
2.2.2.15.3.1.1 RRestrictingObjectId properties
PropertyValue
Name RRestrictingObjectId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.15.3.2 Field ProductId
2.2.2.15.3.2.1 ProductId properties
PropertyValue
Name ProductId
Technical name
Activated true
Id
Type string
Description

Reference to the product which the restricting object belongs to

Dependencies
Required
Primary key false
Foreign collection Product
Foreign field ProductId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.15.3.3 Field Type
2.2.2.15.3.3.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.15.3.4 Field Class
2.2.2.15.3.4.1 Class properties
PropertyValue
Name Class
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.15.3.5 Field AutomaticDrive
2.2.2.15.3.5.1 AutomaticDrive properties
PropertyValue
Name AutomaticDrive
Technical name
Activated true
Id
Type boolean
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Sample
Comments
2.2.2.15.3.6 Field NumberOfDrives
2.2.2.15.3.6.1 NumberOfDrives properties
PropertyValue
Name NumberOfDrives
Technical name
Activated true
Id
Type number
Description

Number of drives

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.15.4 RRestrictingObject JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "RRestrictingObject",
    "additionalProperties": false,
    "properties": {
        "RRestrictingObjectId": {
            "type": "string",
            "description": "Customer ID from previous system (ID before onboarding data to BM)"
        },
        "ProductId": {
            "type": "string",
            "description": "Reference to the product which the restricting object belongs to"
        },
        "Type": {
            "type": "string"
        },
        "Class": {
            "type": "string"
        },
        "AutomaticDrive": {
            "type": "boolean"
        },
        "NumberOfDrives": {
            "type": "number",
            "description": "Number of drives"
        }
    }
}
2.2.2.15.5 RRestrictingObject JSON data
{
    "RRestrictingObjectId": "Lorem",
    "ProductId": "Lorem",
    "Type": "Lorem",
    "Class": "Lorem",
    "AutomaticDrive": true,
    "NumberOfDrives": -21
}
2.2.2.16 Document Servitudes
2.2.2.16.1 Servitudes Tree Diagram
2.2.2.16.2 Servitudes Properties
PropertyValue
Document nameServitudes
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.16.3 Servitudes Fields
FieldTypeReqKeyDescriptionComments
ServitudeIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

Typestringfalse

Type of servitude e.g: Public Servitude, Personal Servitude (Usufruct, Usus)

ValidFromstringfalse

Date servitude starts e.g: 29.10.19

[{"dataType":"dateTime"}]

ValidUntilstringfalse

Date servitude ends e.g: 30.11.21

[{"dataType":"dateTime"}]

LandIdstringfalse

Reference to the land which the servitudes belongs to

Guidstringfalse

Globally Unique Identifier number

2.2.2.16.3.1 Field ServitudeId
2.2.2.16.3.1.1 ServitudeId properties
PropertyValue
Name ServitudeId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.16.3.2 Field Type
2.2.2.16.3.2.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description

Type of servitude e.g: Public Servitude, Personal Servitude (Usufruct, Usus)

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.16.3.3 Field ValidFrom
2.2.2.16.3.3.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name
Activated true
Id
Type string
Description

Date servitude starts e.g: 29.10.19

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.16.3.4 Field ValidUntil
2.2.2.16.3.4.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name
Activated true
Id
Type string
Description

Date servitude ends e.g: 30.11.21

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.16.3.5 Field LandId
2.2.2.16.3.5.1 LandId properties
PropertyValue
Name LandId
Technical name Lndd
Activated true
Id
Type string
Description

Reference to the land which the servitudes belongs to

Dependencies
Required
Primary key false
Foreign collection Land
Foreign field LandId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.16.3.6 Field Guid
2.2.2.16.3.6.1 Guid properties
PropertyValue
Name Guid
Technical name
Activated true
Id
Type string
Description

Globally Unique Identifier number

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.16.4 Servitudes JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Servitudes",
    "additionalProperties": false,
    "properties": {
        "ServitudeId": {
            "type": "string",
            "description": "Customer ID from previous system (ID before onboarding data to BM)"
        },
        "Type": {
            "type": "string",
            "description": "Type of servitude e.g: Public Servitude, Personal Servitude (Usufruct, Usus)"
        },
        "ValidFrom": {
            "type": "string",
            "description": "Date servitude  starts e.g: 29.10.19"
        },
        "ValidUntil": {
            "type": "string",
            "description": "Date servitude ends  e.g: 30.11.21"
        },
        "Lndd": {
            "type": "string",
            "description": "Reference to the land which the servitudes belongs to"
        },
        "Guid": {
            "type": "string",
            "description": "Globally Unique Identifier number"
        }
    }
}
2.2.2.16.5 Servitudes JSON data
{
    "ServitudeId": "Lorem",
    "Type": "Lorem",
    "ValidFrom": "Lorem",
    "ValidUntil": "Lorem",
    "Lndd": "Lorem",
    "Guid": "Lorem"
}
2.2.2.17 Document Site
2.2.2.17.1 Site Tree Diagram
2.2.2.17.2 Site Properties
PropertyValue
Document nameSite
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.17.3 Site Fields
FieldTypeReqKeyDescriptionComments
SiteIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

Namestringtrue

Name of Site e.g: Siemensstadt

SiteCodestringfalse

User specific Site Code e.g: SB001

Typestringfalse

Ownership type of site e.g: owned, leased

ValidFromstringfalse

Date site is acquired / lease starts e.g: 10.10.20

[{"dataType":"dateTime"}]

ValidUntilstringtrue

Date site is sold /lease contract ends e.g: 12.10.30

[{"dataType":"dateTime"}]

AddressIdstringfalse

Reference to the corresponding Address Entity

BusinessPartnerIdstringfalse
Guidstringfalse

Globally Unique Identifier number

2.2.2.17.3.1 Field SiteId
2.2.2.17.3.1.1 SiteId properties
PropertyValue
Name SiteId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.17.3.2 Field Name
2.2.2.17.3.2.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description

Name of Site e.g: Siemensstadt

Dependencies
Required true
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.17.3.3 Field SiteCode
2.2.2.17.3.3.1 SiteCode properties
PropertyValue
Name SiteCode
Technical name
Activated true
Id
Type string
Description

User specific Site Code e.g: SB001

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.17.3.4 Field Type
2.2.2.17.3.4.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description

Ownership type of site e.g: owned, leased

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.17.3.5 Field ValidFrom
2.2.2.17.3.5.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name
Activated true
Id
Type string
Description

Date site is acquired / lease starts e.g: 10.10.20

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.17.3.6 Field ValidUntil
2.2.2.17.3.6.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name Vldntl
Activated true
Id
Type string
Description

Date site is sold /lease contract ends e.g: 12.10.30

Dependencies
Required true
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.17.3.7 Field AddressId
2.2.2.17.3.7.1 AddressId properties
PropertyValue
Name AddressId
Technical name
Activated true
Id
Type string
Description

Reference to the corresponding Address Entity

Dependencies
Required
Primary key false
Foreign collection Address1
Foreign field AddressId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.17.3.8 Field BusinessPartnerId
2.2.2.17.3.8.1 BusinessPartnerId properties
PropertyValue
Name BusinessPartnerId
Technical name BsnssPrtnrd
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection BusinessPartner
Foreign field BusinessPartnerId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.17.3.9 Field Guid
2.2.2.17.3.9.1 Guid properties
PropertyValue
Name Guid
Technical name
Activated true
Id
Type string
Description

Globally Unique Identifier number

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.17.4 Site JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Site",
    "additionalProperties": false,
    "properties": {
        "SiteId": {
            "type": "string",
            "description": "Customer ID from previous system (ID before onboarding data to BM)"
        },
        "Name": {
            "type": "string",
            "description": "Name of Site e.g: Siemensstadt"
        },
        "SiteCode": {
            "type": "string",
            "description": "User specific Site Code e.g: SB001"
        },
        "Type": {
            "type": "string",
            "description": "Ownership type of site e.g: owned, leased"
        },
        "ValidFrom": {
            "type": "string",
            "description": "Date site is acquired / lease starts  e.g: 10.10.20"
        },
        "Vldntl": {
            "type": "string",
            "description": "Date site is sold /lease contract ends  e.g: 12.10.30 "
        },
        "AddressId": {
            "type": "string",
            "description": "Reference to the corresponding Address Entity"
        },
        "BsnssPrtnrd": {
            "type": "string"
        },
        "Guid": {
            "type": "string",
            "description": "Globally Unique Identifier number"
        }
    },
    "required": [
        "Name",
        "Vldntl"
    ]
}
2.2.2.17.5 Site JSON data
{
    "SiteId": "Lorem",
    "Name": "Lorem",
    "SiteCode": "Lorem",
    "Type": "Lorem",
    "ValidFrom": "Lorem",
    "Vldntl": "Lorem",
    "AddressId": "Lorem",
    "BsnssPrtnrd": "Lorem",
    "Guid": "Lorem"
}
2.2.2.18 Document Space
2.2.2.18.1 Space Tree Diagram
2.2.2.18.2 Space Properties
PropertyValue
Document nameSpace
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.18.3 Space Fields
FieldTypeReqKeyDescriptionComments
SpaceIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

Namestringtrue

Name of space e.g: WC, Meeting room 3c

SpaceCodestringfalse

User specific Space Code e.g: MR003

SpaceNumberstringfalse

Number of space e.g: 4

Typestringfalse

Type of space e.g: office, laboratory, storage

ValidFromstringfalse

Date space is defined e.g: 10.10.20

[{"dataType":"dateTime"}]

ValidUntilstringtrue

Date space needs to be re-checked / changes e.g: 12.10.30

[{"dataType":"dateTime"}]

SpaceHightUsablenumberfalse

Usable Hight of space e.g: 3.3 sqm

[{"dataType":"float"}]

SpaceHightnumberfalse

Actual space hight e.g: 3.6 sqm

[{"dataType":"float"}]

SpaceVolumeGrossnumberfalse

Gross volume of space including surrounding walls e.g: 90.5 cubic meters

[{"dataType":"float"}]

SpaceVolumeNetnumberfalse

Gross volume of space excluding surrounding walls e.g: 88.3 cubic meters

[{"dataType":"float"}]

FloorMaterialstringfalse

Material of floor e.g: wood

WallMaterialstringfalse

Material of wall e.g: cement

CeilingMaterialstringfalse

Material of ceiling e.g: cement

Rentabilitybooleanfalse

Status of the space is eligible for renting out (Y/N)

EffectZonesHeatingstringfalse
EffectZonesCoolingstringfalse
EffectZonesVentilationstringfalse
ClimateHeatedbooleanfalse

Define if space is climate heated (Y/N)

ClimateCooledbooleanfalse

Define if space is climate cooled (Y/N)

CoUseAreabooleanfalse

Is the space used by multiple tenants (Y/N)

MaximumOccupancynumberfalse

Define maximum occupancy of space e.g: 5

VentilationTypestringfalse

Define the ventilation type e.g: exhaust, supply, balanced, and heat-recovery

FloorIdstringfalse

Reference to the floor which the space belongs to

Guidstringfalse

Globally Unique Identifier number

2.2.2.18.3.1 Field Name
2.2.2.18.3.1.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description

Name of space e.g: WC, Meeting room 3c

Dependencies
Required true
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.18.3.2 Field SpaceId
2.2.2.18.3.2.1 SpaceId properties
PropertyValue
Name SpaceId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.18.3.3 Field SpaceCode
2.2.2.18.3.3.1 SpaceCode properties
PropertyValue
Name SpaceCode
Technical name
Activated true
Id
Type string
Description

User specific Space Code e.g: MR003

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.18.3.4 Field SpaceNumber
2.2.2.18.3.4.1 SpaceNumber properties
PropertyValue
Name SpaceNumber
Technical name
Activated true
Id
Type string
Description

Number of space e.g: 4

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.18.3.5 Field Type
2.2.2.18.3.5.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description

Type of space e.g: office, laboratory, storage

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.18.3.6 Field ValidFrom
2.2.2.18.3.6.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name
Activated true
Id
Type string
Description

Date space is defined e.g: 10.10.20

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.18.3.7 Field ValidUntil
2.2.2.18.3.7.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name
Activated true
Id
Type string
Description

Date space needs to be re-checked / changes e.g: 12.10.30

Dependencies
Required true
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.18.3.8 Field SpaceHightUsable
2.2.2.18.3.8.1 SpaceHightUsable properties
PropertyValue
Name SpaceHightUsable
Technical name
Activated true
Id
Type number
Description

Usable Hight of space e.g: 3.3 sqm

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.18.3.9 Field SpaceHight
2.2.2.18.3.9.1 SpaceHight properties
PropertyValue
Name SpaceHight
Technical name
Activated true
Id
Type number
Description

Actual space hight e.g: 3.6 sqm

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.18.3.10 Field SpaceVolumeGross
2.2.2.18.3.10.1 SpaceVolumeGross properties
PropertyValue
Name SpaceVolumeGross
Technical name
Activated true
Id
Type number
Description

Gross volume of space including surrounding walls e.g: 90.5 cubic meters

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.18.3.11 Field SpaceVolumeNet
2.2.2.18.3.11.1 SpaceVolumeNet properties
PropertyValue
Name SpaceVolumeNet
Technical name
Activated true
Id
Type number
Description

Gross volume of space excluding surrounding walls e.g: 88.3 cubic meters

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.18.3.12 Field FloorMaterial
2.2.2.18.3.12.1 FloorMaterial properties
PropertyValue
Name FloorMaterial
Technical name
Activated true
Id
Type string
Description

Material of floor e.g: wood

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.18.3.13 Field WallMaterial
2.2.2.18.3.13.1 WallMaterial properties
PropertyValue
Name WallMaterial
Technical name
Activated true
Id
Type string
Description

Material of wall e.g: cement

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.18.3.14 Field CeilingMaterial
2.2.2.18.3.14.1 CeilingMaterial properties
PropertyValue
Name CeilingMaterial
Technical name
Activated true
Id
Type string
Description

Material of ceiling e.g: cement

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.18.3.15 Field Rentability
2.2.2.18.3.15.1 Rentability properties
PropertyValue
Name Rentability
Technical name
Activated true
Id
Type boolean
Description

Status of the space is eligible for renting out (Y/N)

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Sample
Comments
2.2.2.18.3.16 Field EffectZonesHeating
2.2.2.18.3.16.1 EffectZonesHeating properties
PropertyValue
Name EffectZonesHeating
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.18.3.17 Field EffectZonesCooling
2.2.2.18.3.17.1 EffectZonesCooling properties
PropertyValue
Name EffectZonesCooling
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.18.3.18 Field EffectZonesVentilation
2.2.2.18.3.18.1 EffectZonesVentilation properties
PropertyValue
Name EffectZonesVentilation
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.18.3.19 Field ClimateHeated
2.2.2.18.3.19.1 ClimateHeated properties
PropertyValue
Name ClimateHeated
Technical name
Activated true
Id
Type boolean
Description

Define if space is climate heated (Y/N)

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Sample
Comments
2.2.2.18.3.20 Field ClimateCooled
2.2.2.18.3.20.1 ClimateCooled properties
PropertyValue
Name ClimateCooled
Technical name
Activated true
Id
Type boolean
Description

Define if space is climate cooled (Y/N)

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Sample
Comments
2.2.2.18.3.21 Field CoUseArea
2.2.2.18.3.21.1 CoUseArea properties
PropertyValue
Name CoUseArea
Technical name
Activated true
Id
Type boolean
Description

Is the space used by multiple tenants (Y/N)

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Sample
Comments
2.2.2.18.3.22 Field MaximumOccupancy
2.2.2.18.3.22.1 MaximumOccupancy properties
PropertyValue
Name MaximumOccupancy
Technical name
Activated true
Id
Type number
Description

Define maximum occupancy of space e.g: 5

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.18.3.23 Field VentilationType
2.2.2.18.3.23.1 VentilationType properties
PropertyValue
Name VentilationType
Technical name
Activated true
Id
Type string
Description

Define the ventilation type e.g: exhaust, supply, balanced, and heat-recovery

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.18.3.24 Field FloorId
2.2.2.18.3.24.1 FloorId properties
PropertyValue
Name FloorId
Technical name Flrd
Activated true
Id
Type string
Description

Reference to the floor which the space belongs to

Dependencies
Required
Primary key false
Foreign collection Floor
Foreign field FloorId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.18.3.25 Field Guid
2.2.2.18.3.25.1 Guid properties
PropertyValue
Name Guid
Technical name
Activated true
Id
Type string
Description

Globally Unique Identifier number

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.18.4 Space JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Space",
    "additionalProperties": false,
    "properties": {
        "Name": {
            "type": "string",
            "description": "Name of space e.g: WC, Meeting room 3c"
        },
        "SpaceId": {
            "type": "string",
            "description": "Customer ID from previous system (ID before onboarding data to BM)"
        },
        "SpaceCode": {
            "type": "string",
            "description": "User specific Space Code e.g: MR003"
        },
        "SpaceNumber": {
            "type": "string",
            "description": "Number of space e.g: 4"
        },
        "Type": {
            "type": "string",
            "description": "Type of space e.g: office, laboratory, storage"
        },
        "ValidFrom": {
            "type": "string",
            "description": "Date space is defined  e.g: 10.10.20"
        },
        "ValidUntil": {
            "type": "string",
            "description": "Date space needs to be re-checked / changes  e.g: 12.10.30"
        },
        "SpaceHightUsable": {
            "type": "number",
            "description": "Usable Hight of space e.g: 3.3 sqm"
        },
        "SpaceHight": {
            "type": "number",
            "description": "Actual space hight e.g: 3.6 sqm"
        },
        "SpaceVolumeGross": {
            "type": "number",
            "description": "Gross volume of space including surrounding walls  e.g: 90.5 cubic meters"
        },
        "SpaceVolumeNet": {
            "type": "number",
            "description": "Gross volume of space excluding surrounding  walls  e.g: 88.3 cubic meters"
        },
        "FloorMaterial": {
            "type": "string",
            "description": "Material of floor e.g: wood"
        },
        "WallMaterial": {
            "type": "string",
            "description": "Material of wall e.g: cement"
        },
        "CeilingMaterial": {
            "type": "string",
            "description": "Material of ceiling e.g: cement"
        },
        "Rentability": {
            "type": "boolean",
            "description": "Status of the space is eligible for renting out (Y/N)"
        },
        "EffectZonesHeating": {
            "type": "string"
        },
        "EffectZonesCooling": {
            "type": "string"
        },
        "EffectZonesVentilation": {
            "type": "string"
        },
        "ClimateHeated": {
            "type": "boolean",
            "description": "Define if space is climate heated (Y/N)"
        },
        "ClimateCooled": {
            "type": "boolean",
            "description": "Define if space is climate cooled (Y/N)"
        },
        "CoUseArea": {
            "type": "boolean",
            "description": "Is the space used by multiple tenants (Y/N)"
        },
        "MaximumOccupancy": {
            "type": "number",
            "description": "Define maximum occupancy of space e.g: 5"
        },
        "VentilationType": {
            "type": "string",
            "description": "Define the ventilation type e.g: exhaust, supply, balanced, and heat-recovery"
        },
        "Flrd": {
            "type": "string",
            "description": "Reference to the floor which the space belongs to"
        },
        "Guid": {
            "type": "string",
            "description": "Globally Unique Identifier number"
        }
    },
    "required": [
        "Name",
        "ValidUntil"
    ]
}
2.2.2.18.5 Space JSON data
{
    "Name": "Lorem",
    "SpaceId": "Lorem",
    "SpaceCode": "Lorem",
    "SpaceNumber": "Lorem",
    "Type": "Lorem",
    "ValidFrom": "Lorem",
    "ValidUntil": "Lorem",
    "SpaceHightUsable": -75,
    "SpaceHight": 14,
    "SpaceVolumeGross": -60,
    "SpaceVolumeNet": -46,
    "FloorMaterial": "Lorem",
    "WallMaterial": "Lorem",
    "CeilingMaterial": "Lorem",
    "Rentability": true,
    "EffectZonesHeating": "Lorem",
    "EffectZonesCooling": "Lorem",
    "EffectZonesVentilation": "Lorem",
    "ClimateHeated": true,
    "ClimateCooled": true,
    "CoUseArea": true,
    "MaximumOccupancy": 13,
    "VentilationType": "Lorem",
    "Flrd": "Lorem",
    "Guid": "Lorem"
}
2.2.2.19 Document UHoldingObject
2.2.2.19.1 UHoldingObject Tree Diagram
2.2.2.19.2 UHoldingObject Properties
PropertyValue
Document nameUHoldingObject
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.19.3 UHoldingObject Fields
FieldTypeReqKeyDescriptionComments
UHoldingObjectIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

ProductIdstringfalse

Reference to the product which the holding object belongs to

FireWallbooleanfalse

Is it a firewall (Y/N)

AcousticsInsulationstringfalse

Existing type of acoustic insulation

FireResistanceClassstringfalse
SurfaceAreastringfalse
WallStrengthstringfalse
TypeOfSurfacestringfalse
WallConstructionstringfalse
LoadBearingWallbooleanfalse

Is it a load bearing wall (Y/N)

2.2.2.19.3.1 Field UHoldingObjectId
2.2.2.19.3.1.1 UHoldingObjectId properties
PropertyValue
Name UHoldingObjectId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.19.3.2 Field ProductId
2.2.2.19.3.2.1 ProductId properties
PropertyValue
Name ProductId
Technical name
Activated true
Id
Type string
Description

Reference to the product which the holding object belongs to

Dependencies
Required
Primary key false
Foreign collection Product
Foreign field ProductId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.19.3.3 Field FireWall
2.2.2.19.3.3.1 FireWall properties
PropertyValue
Name FireWall
Technical name
Activated true
Id
Type boolean
Description

Is it a firewall (Y/N)

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Sample
Comments
2.2.2.19.3.4 Field AcousticsInsulation
2.2.2.19.3.4.1 AcousticsInsulation properties
PropertyValue
Name AcousticsInsulation
Technical name
Activated true
Id
Type string
Description

Existing type of acoustic insulation

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.19.3.5 Field FireResistanceClass
2.2.2.19.3.5.1 FireResistanceClass properties
PropertyValue
Name FireResistanceClass
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.19.3.6 Field SurfaceArea
2.2.2.19.3.6.1 SurfaceArea properties
PropertyValue
Name SurfaceArea
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.19.3.7 Field WallStrength
2.2.2.19.3.7.1 WallStrength properties
PropertyValue
Name WallStrength
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.19.3.8 Field TypeOfSurface
2.2.2.19.3.8.1 TypeOfSurface properties
PropertyValue
Name TypeOfSurface
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.19.3.9 Field WallConstruction
2.2.2.19.3.9.1 WallConstruction properties
PropertyValue
Name WallConstruction
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.19.3.10 Field LoadBearingWall
2.2.2.19.3.10.1 LoadBearingWall properties
PropertyValue
Name LoadBearingWall
Technical name
Activated true
Id
Type boolean
Description

Is it a load bearing wall (Y/N)

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Sample
Comments
2.2.2.19.4 UHoldingObject JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "UHoldingObject",
    "additionalProperties": false,
    "properties": {
        "UHoldingObjectId": {
            "type": "string",
            "description": "Customer ID from previous system  (ID before onboarding data to BM)"
        },
        "ProductId": {
            "type": "string",
            "description": "Reference to the product which the holding object belongs to"
        },
        "FireWall": {
            "type": "boolean",
            "description": "Is it a firewall (Y/N)"
        },
        "AcousticsInsulation": {
            "type": "string",
            "description": "Existing type of acoustic insulation"
        },
        "FireResistanceClass": {
            "type": "string"
        },
        "SurfaceArea": {
            "type": "string"
        },
        "WallStrength": {
            "type": "string"
        },
        "TypeOfSurface": {
            "type": "string"
        },
        "WallConstruction": {
            "type": "string"
        },
        "LoadBearingWall": {
            "type": "boolean",
            "description": "Is it a load bearing wall (Y/N)"
        }
    }
}
2.2.2.19.5 UHoldingObject JSON data
{
    "UHoldingObjectId": "Lorem",
    "ProductId": "Lorem",
    "FireWall": true,
    "AcousticsInsulation": "Lorem",
    "FireResistanceClass": "Lorem",
    "SurfaceArea": "Lorem",
    "WallStrength": "Lorem",
    "TypeOfSurface": "Lorem",
    "WallConstruction": "Lorem",
    "LoadBearingWall": true
}
2.2.2.20 Document Unit
2.2.2.20.1 Unit Tree Diagram
2.2.2.20.2 Unit Properties
PropertyValue
Document nameUnit
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.20.3 Unit Fields
FieldTypeReqKeyDescriptionComments
UnitIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

Typestringfalse

Type of Unit e.g: part of building, rental unit

Namestringfalse

Name of space e.g: east wing, apartment C406

Codestringfalse

User-specific code for unit

ValidFromstringfalse

Date unit is defined / rented out

[{"dataType":"dateTime"}]

ValidUntilstringfalse

Date unit needs to be redefined / lease contract ends

[{"dataType":"dateTime"}]

SiteIdstringfalse

Reference to the site unit belongs to

LandIdstringfalse

Reference to the land unit belongs to

BuildingIdstringfalse

Reference to the building measurement belongs to

SpaceIdstringfalse

Reference to the space measurement belongs to

FloorIdstringfalse

Reference to the floor measurement belongs to

AddressIdstringfalse

Reference to Address which the building belongs to

Guidstringfalse

Globally Unique Identifier number

2.2.2.20.3.1 Field UnitId
2.2.2.20.3.1.1 UnitId properties
PropertyValue
Name UnitId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.20.3.2 Field Type
2.2.2.20.3.2.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description

Type of Unit e.g: part of building, rental unit

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.20.3.3 Field Name
2.2.2.20.3.3.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description

Name of space e.g: east wing, apartment C406

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.20.3.4 Field Code
2.2.2.20.3.4.1 Code properties
PropertyValue
Name Code
Technical name
Activated true
Id
Type string
Description

User-specific code for unit

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.20.3.5 Field ValidFrom
2.2.2.20.3.5.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name
Activated true
Id
Type string
Description

Date unit is defined / rented out

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.20.3.6 Field ValidUntil
2.2.2.20.3.6.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name
Activated true
Id
Type string
Description

Date unit needs to be redefined / lease contract ends

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.2.2.20.3.7 Field SiteId
2.2.2.20.3.7.1 SiteId properties
PropertyValue
Name SiteId
Technical name
Activated true
Id
Type string
Description

Reference to the site unit belongs to

Dependencies
Required
Primary key false
Foreign collection Site
Foreign field SiteId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.20.3.8 Field LandId
2.2.2.20.3.8.1 LandId properties
PropertyValue
Name LandId
Technical name
Activated true
Id
Type string
Description

Reference to the land unit belongs to

Dependencies
Required
Primary key false
Foreign collection Land
Foreign field LandId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.20.3.9 Field BuildingId
2.2.2.20.3.9.1 BuildingId properties
PropertyValue
Name BuildingId
Technical name
Activated true
Id
Type string
Description

Reference to the building measurement belongs to

Dependencies
Required
Primary key false
Foreign collection Building
Foreign field BuildingId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.20.3.10 Field SpaceId
2.2.2.20.3.10.1 SpaceId properties
PropertyValue
Name SpaceId
Technical name
Activated true
Id
Type string
Description

Reference to the space measurement belongs to

Dependencies
Required
Primary key false
Foreign collection Space
Foreign field SpaceId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.20.3.11 Field FloorId
2.2.2.20.3.11.1 FloorId properties
PropertyValue
Name FloorId
Technical name
Activated true
Id
Type string
Description

Reference to the floor measurement belongs to

Dependencies
Required
Primary key false
Foreign collection Floor
Foreign field FloorId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.20.3.12 Field AddressId
2.2.2.20.3.12.1 AddressId properties
PropertyValue
Name AddressId
Technical name
Activated true
Id
Type string
Description

Reference to Address which the building belongs to

Dependencies
Required
Primary key false
Foreign collection Address1
Foreign field AddressId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.20.3.13 Field Guid
2.2.2.20.3.13.1 Guid properties
PropertyValue
Name Guid
Technical name
Activated true
Id
Type string
Description

Globally Unique Identifier number

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.20.4 Unit JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Unit",
    "additionalProperties": false,
    "properties": {
        "UnitId": {
            "type": "string",
            "description": "Customer ID from previous system (ID before onboarding data to BM)"
        },
        "Type": {
            "type": "string",
            "description": "Type of Unit e.g: part of building, rental unit"
        },
        "Name": {
            "type": "string",
            "description": "Name of space e.g: east wing, apartment C406"
        },
        "Code": {
            "type": "string",
            "description": "User-specific code for unit"
        },
        "ValidFrom": {
            "type": "string",
            "description": "Date unit is defined / rented out"
        },
        "ValidUntil": {
            "type": "string",
            "description": "Date unit needs to be redefined / lease contract ends "
        },
        "SiteId": {
            "type": "string",
            "description": "Reference to the site unit belongs to"
        },
        "LandId": {
            "type": "string",
            "description": "Reference to the land unit belongs to"
        },
        "BuildingId": {
            "type": "string",
            "description": "Reference to the building measurement belongs to"
        },
        "SpaceId": {
            "type": "string",
            "description": "Reference to the space measurement belongs to"
        },
        "FloorId": {
            "type": "string",
            "description": "Reference to the floor measurement belongs to"
        },
        "AddressId": {
            "type": "string",
            "description": "Reference to Address which the building belongs to"
        },
        "Guid": {
            "type": "string",
            "description": "Globally Unique Identifier number"
        }
    }
}
2.2.2.20.5 Unit JSON data
{
    "UnitId": "Lorem",
    "Type": "Lorem",
    "Name": "Lorem",
    "Code": "Lorem",
    "ValidFrom": "Lorem",
    "ValidUntil": "Lorem",
    "SiteId": "Lorem",
    "LandId": "Lorem",
    "BuildingId": "Lorem",
    "SpaceId": "Lorem",
    "FloorId": "Lorem",
    "AddressId": "Lorem",
    "Guid": "Lorem"
}
2.2.2.21 Document XInterfacingObject
2.2.2.21.1 XInterfacingObject Tree Diagram
2.2.2.21.2 XInterfacingObject Properties
PropertyValue
Document nameXInterfacingObject
Technical name
Activatedtrue
Id
Description
GroupDigital Twin
RESTful API
Additional propertiesfalse
Comments
2.2.2.21.3 XInterfacingObject Fields
FieldTypeReqKeyDescriptionComments
XInterfacingObjectIdstringfalse

Customer ID from previous system (ID before onboarding data to BM)

ProductIdstringfalse

Reference to the product which the interfacing object belongs to

Typestringfalse
Classstringfalse
Activatorstringfalse
AVSVCoulingSwitstringfalse
CircuitBreakerstringfalse
ElectricalConnectionstringfalse
EmergencyPowerFeedsstringfalse
FittingTypestringfalse
FuesProtectionstringfalse
FuseProtectionstringfalse
ModelRangestringfalse
NumberOfCabinetsnumberfalse

Number of cabinets

NumberOfConvertersnumberfalse

Number of converters

NumberOfFeedsnumberfalse

Number of feeds

NumberOfPowerCircuitsnumberfalse

Number of power circuits

NumberOFSafetExitsnumberfalse

Number of safe exits

OperatingVoltagenumberfalse

[{"dataType":"float"}]

OvervoltageProtectionstringfalse
Powernumberfalse

[{"dataType":"float"}]

PrimaryVoltagenumberfalse

[{"dataType":"float"}]

SecondaryVoltagenumberfalse

[{"dataType":"float"}]

VandalProofingstringfalse
Versionstringfalse
Voltagenumberfalse

[{"dataType":"float"}]

2.2.2.21.3.1 Field XInterfacingObjectId
2.2.2.21.3.1.1 XInterfacingObjectId properties
PropertyValue
Name XInterfacingObjectId
Technical name
Activated true
Id
Type string
Description

Customer ID from previous system (ID before onboarding data to BM)

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.21.3.2 Field ProductId
2.2.2.21.3.2.1 ProductId properties
PropertyValue
Name ProductId
Technical name
Activated true
Id
Type string
Description

Reference to the product which the interfacing object belongs to

Dependencies
Required
Primary key false
Foreign collection Product
Foreign field ProductId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.21.3.3 Field Type
2.2.2.21.3.3.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.21.3.4 Field Class
2.2.2.21.3.4.1 Class properties
PropertyValue
Name Class
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.21.3.5 Field Activator
2.2.2.21.3.5.1 Activator properties
PropertyValue
Name Activator
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.21.3.6 Field AVSVCoulingSwit
2.2.2.21.3.6.1 AVSVCoulingSwit properties
PropertyValue
Name AVSVCoulingSwit
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.21.3.7 Field CircuitBreaker
2.2.2.21.3.7.1 CircuitBreaker properties
PropertyValue
Name CircuitBreaker
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.21.3.8 Field ElectricalConnection
2.2.2.21.3.8.1 ElectricalConnection properties
PropertyValue
Name ElectricalConnection
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.21.3.9 Field EmergencyPowerFeeds
2.2.2.21.3.9.1 EmergencyPowerFeeds properties
PropertyValue
Name EmergencyPowerFeeds
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.21.3.10 Field FittingType
2.2.2.21.3.10.1 FittingType properties
PropertyValue
Name FittingType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.21.3.11 Field FuesProtection
2.2.2.21.3.11.1 FuesProtection properties
PropertyValue
Name FuesProtection
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.21.3.12 Field FuseProtection
2.2.2.21.3.12.1 FuseProtection properties
PropertyValue
Name FuseProtection
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.21.3.13 Field ModelRange
2.2.2.21.3.13.1 ModelRange properties
PropertyValue
Name ModelRange
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.21.3.14 Field NumberOfCabinets
2.2.2.21.3.14.1 NumberOfCabinets properties
PropertyValue
Name NumberOfCabinets
Technical name
Activated true
Id
Type number
Description

Number of cabinets

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.21.3.15 Field NumberOfConverters
2.2.2.21.3.15.1 NumberOfConverters properties
PropertyValue
Name NumberOfConverters
Technical name
Activated true
Id
Type number
Description

Number of converters

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.21.3.16 Field NumberOfFeeds
2.2.2.21.3.16.1 NumberOfFeeds properties
PropertyValue
Name NumberOfFeeds
Technical name
Activated true
Id
Type number
Description

Number of feeds

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.21.3.17 Field NumberOfPowerCircuits
2.2.2.21.3.17.1 NumberOfPowerCircuits properties
PropertyValue
Name NumberOfPowerCircuits
Technical name
Activated true
Id
Type number
Description

Number of power circuits

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.21.3.18 Field NumberOFSafetExits
2.2.2.21.3.18.1 NumberOFSafetExits properties
PropertyValue
Name NumberOFSafetExits
Technical name
Activated true
Id
Type number
Description

Number of safe exits

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.2.2.21.3.19 Field OperatingVoltage
2.2.2.21.3.19.1 OperatingVoltage properties
PropertyValue
Name OperatingVoltage
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.21.3.20 Field OvervoltageProtection
2.2.2.21.3.20.1 OvervoltageProtection properties
PropertyValue
Name OvervoltageProtection
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.21.3.21 Field Power
2.2.2.21.3.21.1 Power properties
PropertyValue
Name Power
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.21.3.22 Field PrimaryVoltage
2.2.2.21.3.22.1 PrimaryVoltage properties
PropertyValue
Name PrimaryVoltage
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.21.3.23 Field SecondaryVoltage
2.2.2.21.3.23.1 SecondaryVoltage properties
PropertyValue
Name SecondaryVoltage
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.21.3.24 Field VandalProofing
2.2.2.21.3.24.1 VandalProofing properties
PropertyValue
Name VandalProofing
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.21.3.25 Field Version
2.2.2.21.3.25.1 Version properties
PropertyValue
Name Version
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.2.2.21.3.26 Field Voltage
2.2.2.21.3.26.1 Voltage properties
PropertyValue
Name Voltage
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.2.2.21.4 XInterfacingObject JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "XInterfacingObject",
    "additionalProperties": false,
    "properties": {
        "XInterfacingObjectId": {
            "type": "string",
            "description": "Customer ID from previous system (ID before onboarding data to BM)"
        },
        "ProductId": {
            "type": "string",
            "description": "Reference to the product which the interfacing object belongs to"
        },
        "Type": {
            "type": "string"
        },
        "Class": {
            "type": "string"
        },
        "Activator": {
            "type": "string"
        },
        "AVSVCoulingSwit": {
            "type": "string"
        },
        "CircuitBreaker": {
            "type": "string"
        },
        "ElectricalConnection": {
            "type": "string"
        },
        "EmergencyPowerFeeds": {
            "type": "string"
        },
        "FittingType": {
            "type": "string"
        },
        "FuesProtection": {
            "type": "string"
        },
        "FuseProtection": {
            "type": "string"
        },
        "ModelRange": {
            "type": "string"
        },
        "NumberOfCabinets": {
            "type": "number",
            "description": "Number of cabinets"
        },
        "NumberOfConverters": {
            "type": "number",
            "description": "Number of converters"
        },
        "NumberOfFeeds": {
            "type": "number",
            "description": "Number of feeds"
        },
        "NumberOfPowerCircuits": {
            "type": "number",
            "description": "Number of power circuits"
        },
        "NumberOFSafetExits": {
            "type": "number",
            "description": "Number of safe exits"
        },
        "OperatingVoltage": {
            "type": "number"
        },
        "OvervoltageProtection": {
            "type": "string"
        },
        "Power": {
            "type": "number"
        },
        "PrimaryVoltage": {
            "type": "number"
        },
        "SecondaryVoltage": {
            "type": "number"
        },
        "VandalProofing": {
            "type": "string"
        },
        "Version": {
            "type": "string"
        },
        "Voltage": {
            "type": "number"
        }
    }
}
2.2.2.21.5 XInterfacingObject JSON data
{
    "XInterfacingObjectId": "Lorem",
    "ProductId": "Lorem",
    "Type": "Lorem",
    "Class": "Lorem",
    "Activator": "Lorem",
    "AVSVCoulingSwit": "Lorem",
    "CircuitBreaker": "Lorem",
    "ElectricalConnection": "Lorem",
    "EmergencyPowerFeeds": "Lorem",
    "FittingType": "Lorem",
    "FuesProtection": "Lorem",
    "FuseProtection": "Lorem",
    "ModelRange": "Lorem",
    "NumberOfCabinets": 8,
    "NumberOfConverters": -72,
    "NumberOfFeeds": 69,
    "NumberOfPowerCircuits": 1,
    "NumberOFSafetExits": 62,
    "OperatingVoltage": -60,
    "OvervoltageProtection": "Lorem",
    "Power": 87,
    "PrimaryVoltage": -15,
    "SecondaryVoltage": -19,
    "VandalProofing": "Lorem",
    "Version": "Lorem",
    "Voltage": -28
}
2.3 Group Documentation
2.3.1 Documentation Properties
PropertyValue
Group nameDocumentation
Technical name
Activatedtrue
Description
Comments
2.3.2 Documentation Documents
2.3.2.1 Document Document
2.3.2.1.1 Document Tree Diagram
2.3.2.1.2 Document Properties
PropertyValue
Document nameDocument
Technical name
Activatedtrue
Id
Description
GroupDocumentation
RESTful API
Additional propertiesfalse
Comments
2.3.2.1.3 Document Fields
FieldTypeReqKeyDescriptionComments
DocumentIdstringfalse
2.3.2.1.3.1 Field DocumentId
2.3.2.1.3.1.1 DocumentId properties
PropertyValue
Name DocumentId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.3.2.1.4 Document JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Document",
    "additionalProperties": false,
    "properties": {
        "DocumentId": {
            "type": "string"
        }
    }
}
2.3.2.1.5 Document JSON data
{
    "DocumentId": "Lorem"
}
2.3.2.2 Document DocumentClassificationMasterData
2.3.2.2.1 DocumentClassificationMasterData Tree Diagram
2.3.2.2.2 DocumentClassificationMasterData Properties
PropertyValue
Document nameDocumentClassificationMasterData
Technical name
Activatedtrue
Id
Description
GroupDocumentation
RESTful API
Additional propertiesfalse
Comments
2.3.2.2.3 DocumentClassificationMasterData Fields
FieldTypeReqKeyDescriptionComments
ClassificationIdstringfalse
2.3.2.2.3.1 Field ClassificationId
2.3.2.2.3.1.1 ClassificationId properties
PropertyValue
Name ClassificationId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.3.2.2.4 DocumentClassificationMasterData JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "DocumentClassificationMasterData",
    "additionalProperties": false,
    "properties": {
        "ClassificationId": {
            "type": "string"
        }
    }
}
2.3.2.2.5 DocumentClassificationMasterData JSON data
{
    "ClassificationId": "Lorem"
}
2.4 Group EnergyAndRessources
2.4.1 EnergyAndRessources Properties
PropertyValue
Group nameEnergyAndRessources
Technical name
Activatedtrue
Description
Comments
2.4.2 EnergyAndRessources Documents
2.4.2.1 Document Climate
2.4.2.1.1 Climate Tree Diagram
2.4.2.1.2 Climate Properties
PropertyValue
Document nameClimate
Technical name
Activatedtrue
Id
Description
GroupEnergyAndRessources
RESTful API
Additional properties
Comments
2.4.2.1.3 Climate Fields
FieldTypeReqKeyDescriptionComments
Guidstringfalse

Globally Unique Identifier number

Experimentstringfalse

Type of simulation of regional climate model e.g. Historical, Evaluation, RCP2.6

Temporal resolutionstringfalse

Temporal resolution of data (can be the time period over which raw data is aggregated)

GCMstringfalse

Global climate model used

RCMstringfalse

Regional climate model used

SimVstringfalse

Run number of certain climate model or model combination

EnsMstringfalse

Information on members of a model ensemble and changed conditions ('realisation', 'initialisation', 'physics'). Control member; 'r1i1p1'

Valuestringfalse

Value of observed variable

[{"dataType":"float"}]

Unitstringfalse

Unit of observed value

ValidFromstringfalse

Date observation starts e.g: 29.10.19 15:15

[{"dataType":"dateTime"}]

ValidUntilstringfalse

Date observation end e.g: 29.10.19 15:30

[{"dataType":"dateTime"}]

LocationTypestringfalse

Type of spatial reference e.g. Zip code or geographic coordinates

CoordinateSystemstringfalse

Specific coordinate system used

Locationstringfalse

Localisation of observed data in case of non-grid location types

Latnumberfalse

Latitude coordinate in case of geographic coordinates

Lonnumberfalse

Longitude coordinate in case of geographic coordinates

PosXnumberfalse
PosYnumberfalse

Vertical coordinate in case of projected coordinates

Variablestringfalse

Observed variable

2.4.2.1.3.1 Field Experiment
2.4.2.1.3.1.1 Experiment properties
PropertyValue
Name Experiment
Technical name
Activated true
Id
Type string
Description

Type of simulation of regional climate model e.g. Historical, Evaluation, RCP2.6

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.1.3.2 Field Temporal resolution
2.4.2.1.3.2.1 Temporal resolution properties
PropertyValue
Name Temporal resolution
Technical name
Activated true
Id
Type string
Description

Temporal resolution of data (can be the time period over which raw data is aggregated)

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.1.3.3 Field GCM
2.4.2.1.3.3.1 GCM properties
PropertyValue
Name GCM
Technical name
Activated true
Id
Type string
Description

Global climate model used

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.1.3.4 Field RCM
2.4.2.1.3.4.1 RCM properties
PropertyValue
Name RCM
Technical name
Activated true
Id
Type string
Description

Regional climate model used

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.1.3.5 Field SimV
2.4.2.1.3.5.1 SimV properties
PropertyValue
Name SimV
Technical name
Activated true
Id
Type string
Description

Run number of certain climate model or model combination

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.1.3.6 Field EnsM
2.4.2.1.3.6.1 EnsM properties
PropertyValue
Name EnsM
Technical name
Activated true
Id
Type string
Description

Information on members of a model ensemble and changed conditions ('realisation', 'initialisation', 'physics'). Control member; 'r1i1p1'

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.1.3.7 Field Value
2.4.2.1.3.7.1 Value properties
PropertyValue
Name Value
Technical name
Activated true
Id
Type string
Description

Value of observed variable

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"float"}]

2.4.2.1.3.8 Field Unit
2.4.2.1.3.8.1 Unit properties
PropertyValue
Name Unit
Technical name
Activated true
Id
Type string
Description

Unit of observed value

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.1.3.9 Field ValidFrom
2.4.2.1.3.9.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name
Activated true
Id
Type string
Description

Date observation starts e.g: 29.10.19 15:15

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.4.2.1.3.10 Field ValidUntil
2.4.2.1.3.10.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name
Activated true
Id
Type string
Description

Date observation end e.g: 29.10.19 15:30

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.4.2.1.3.11 Field LocationType
2.4.2.1.3.11.1 LocationType properties
PropertyValue
Name LocationType
Technical name
Activated true
Id
Type string
Description

Type of spatial reference e.g. Zip code or geographic coordinates

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.1.3.12 Field CoordinateSystem
2.4.2.1.3.12.1 CoordinateSystem properties
PropertyValue
Name CoordinateSystem
Technical name
Activated true
Id
Type string
Description

Specific coordinate system used

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.1.3.13 Field Location
2.4.2.1.3.13.1 Location properties
PropertyValue
Name Location
Technical name
Activated true
Id
Type string
Description

Localisation of observed data in case of non-grid location types

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.1.3.14 Field Lat
2.4.2.1.3.14.1 Lat properties
PropertyValue
Name Lat
Technical name
Activated true
Id
Type number
Description

Latitude coordinate in case of geographic coordinates

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.4.2.1.3.15 Field Lon
2.4.2.1.3.15.1 Lon properties
PropertyValue
Name Lon
Technical name
Activated true
Id
Type number
Description

Longitude coordinate in case of geographic coordinates

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.4.2.1.3.16 Field PosX
2.4.2.1.3.16.1 PosX properties
PropertyValue
Name PosX
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.4.2.1.3.17 Field PosY
2.4.2.1.3.17.1 PosY properties
PropertyValue
Name PosY
Technical name
Activated true
Id
Type number
Description

Vertical coordinate in case of projected coordinates

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.4.2.1.3.18 Field Variable
2.4.2.1.3.18.1 Variable properties
PropertyValue
Name Variable
Technical name
Activated true
Id
Type string
Description

Observed variable

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.1.3.19 Field Guid
2.4.2.1.3.19.1 Guid properties
PropertyValue
Name Guid
Technical name
Activated true
Id
Type string
Description

Globally Unique Identifier number

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.1.4 Climate JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Climate",
    "properties": {
        "Experiment": {
            "type": "string",
            "description": "Type of simulation of regional climate model e.g. Historical, Evaluation, RCP2.6"
        },
        "Temporal resolution": {
            "type": "string",
            "description": "Temporal resolution of data (can be the time period over which raw data is aggregated)"
        },
        "GCM": {
            "type": "string",
            "description": "Global climate model used"
        },
        "RCM": {
            "type": "string",
            "description": "Regional climate model used"
        },
        "SimV": {
            "type": "string",
            "description": "Run number of certain climate model or model combination"
        },
        "EnsM": {
            "type": "string",
            "description": "Information on members of a model ensemble and changed conditions ('realisation', 'initialisation', 'physics'). Control member; 'r1i1p1'"
        },
        "Value": {
            "type": "string",
            "description": "Value of observed variable"
        },
        "Unit": {
            "type": "string",
            "description": "Unit of observed value"
        },
        "ValidFrom": {
            "type": "string",
            "description": "Date observation starts e.g: 29.10.19 15:15"
        },
        "ValidUntil": {
            "type": "string",
            "description": "Date observation end e.g: 29.10.19 15:30"
        },
        "LocationType": {
            "type": "string",
            "description": "Type of spatial reference e.g. Zip code or geographic coordinates"
        },
        "CoordinateSystem": {
            "type": "string",
            "description": "Specific coordinate system used"
        },
        "Location": {
            "type": "string",
            "description": "Localisation of observed data in case of non-grid location types"
        },
        "Lat": {
            "type": "number",
            "description": "Latitude coordinate in case of geographic coordinates"
        },
        "Lon": {
            "type": "number",
            "description": "Longitude coordinate in case of geographic coordinates"
        },
        "PosX": {
            "type": "number"
        },
        "PosY": {
            "type": "number",
            "description": "Vertical coordinate in case of projected coordinates"
        },
        "Variable": {
            "type": "string",
            "description": "Observed variable"
        },
        "Guid": {
            "type": "string",
            "description": "Globally Unique Identifier number"
        }
    }
}
2.4.2.1.5 Climate JSON data
{
    "Experiment": "Lorem",
    "Temporal resolution": "Lorem",
    "GCM": "Lorem",
    "RCM": "Lorem",
    "SimV": "Lorem",
    "EnsM": "Lorem",
    "Value": "Lorem",
    "Unit": "Lorem",
    "ValidFrom": "Lorem",
    "ValidUntil": "Lorem",
    "LocationType": "Lorem",
    "CoordinateSystem": "Lorem",
    "Location": "Lorem",
    "Lat": -61,
    "Lon": -40,
    "PosX": 84,
    "PosY": 16,
    "Variable": "Lorem",
    "Guid": "Lorem"
}
2.4.2.2 Document EmissionFactor
2.4.2.2.1 EmissionFactor Tree Diagram
2.4.2.2.2 EmissionFactor Properties
PropertyValue
Document nameEmissionFactor
Technical name
Activatedtrue
Id
Description
GroupEnergyAndRessources
RESTful API
Additional propertiesfalse
Comments
2.4.2.2.3 EmissionFactor Fields
FieldTypeReqKeyDescriptionComments
Guidstringfalse

Globally Unique Identifier number

Countrystringfalse

Country in which the emission factor is valid

Typestringfalse

Type of resource consumption the emission factor refers to

ValidFromstringfalse

Date validity starts e.g: 01.01.19 00:00

[{"dataType":"dateTime"}]

ValidUntilstringfalse

Date validity ends e.g: 31.13.19 23:59

[{"dataType":"dateTime"}]

Valuenumberfalse

Value of emission factor

[{"dataType":"float"}]

Unitstringfalse

Unit of emission factor in terms of kgCO2e per unit of resource consumption

Sourcestringfalse

Source of emission factor e.g. 'International Energy Agency'

SpaceTypestringfalse

Differentiated emission factor for certain space type (within a building)

Regionstringfalse
Citystringfalse
SiteIdstringfalse

Differentiated emission factor for certain site

BuildingIdstringfalse

Differentiated emission factor for certain building

BusinessPartnerIdstringfalse

Identifier of business partner that has entered a user-defined emission factor

OperationalMeasurementGuidstringfalse

Differentiated emission factor for certain operational measurement

2.4.2.2.3.1 Field Country
2.4.2.2.3.1.1 Country properties
PropertyValue
Name Country
Technical name
Activated true
Id
Type string
Description

Country in which the emission factor is valid

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.2.3.2 Field Type
2.4.2.2.3.2.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description

Type of resource consumption the emission factor refers to

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.2.3.3 Field ValidFrom
2.4.2.2.3.3.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name
Activated true
Id
Type string
Description

Date validity starts e.g: 01.01.19 00:00

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.4.2.2.3.4 Field ValidUntil
2.4.2.2.3.4.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name
Activated true
Id
Type string
Description

Date validity ends e.g: 31.13.19 23:59

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.4.2.2.3.5 Field Value
2.4.2.2.3.5.1 Value properties
PropertyValue
Name Value
Technical name
Activated true
Id
Type number
Description

Value of emission factor

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.4.2.2.3.6 Field Unit
2.4.2.2.3.6.1 Unit properties
PropertyValue
Name Unit
Technical name
Activated true
Id
Type string
Description

Unit of emission factor in terms of kgCO2e per unit of resource consumption

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.2.3.7 Field Source
2.4.2.2.3.7.1 Source properties
PropertyValue
Name Source
Technical name
Activated true
Id
Type string
Description

Source of emission factor e.g. 'International Energy Agency'

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.2.3.8 Field SpaceType
2.4.2.2.3.8.1 SpaceType properties
PropertyValue
Name SpaceType
Technical name
Activated true
Id
Type string
Description

Differentiated emission factor for certain space type (within a building)

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.2.3.9 Field Region
2.4.2.2.3.9.1 Region properties
PropertyValue
Name Region
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.2.3.10 Field City
2.4.2.2.3.10.1 City properties
PropertyValue
Name City
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.2.3.11 Field SiteId
2.4.2.2.3.11.1 SiteId properties
PropertyValue
Name SiteId
Technical name
Activated true
Id
Type string
Description

Differentiated emission factor for certain site

Dependencies
Required
Primary key
Foreign collection Site
Foreign field SiteId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.2.3.12 Field BuildingId
2.4.2.2.3.12.1 BuildingId properties
PropertyValue
Name BuildingId
Technical name
Activated true
Id
Type string
Description

Differentiated emission factor for certain building

Dependencies
Required
Primary key
Foreign collection Building
Foreign field BuildingId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.2.3.13 Field BusinessPartnerId
2.4.2.2.3.13.1 BusinessPartnerId properties
PropertyValue
Name BusinessPartnerId
Technical name
Activated true
Id
Type string
Description

Identifier of business partner that has entered a user-defined emission factor

Dependencies
Required
Primary key
Foreign collection BusinessPartner
Foreign field BusinessPartnerId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.2.3.14 Field OperationalMeasurementGuid
2.4.2.2.3.14.1 OperationalMeasurementGuid properties
PropertyValue
Name OperationalMeasurementGuid
Technical name
Activated true
Id
Type string
Description

Differentiated emission factor for certain operational measurement

Dependencies
Required
Primary key
Foreign collection OperationalMeasurement
Foreign field Guid
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.2.3.15 Field Guid
2.4.2.2.3.15.1 Guid properties
PropertyValue
Name Guid
Technical name
Activated true
Id
Type string
Description

Globally Unique Identifier number

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.2.4 EmissionFactor JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "EmissionFactor",
    "additionalProperties": false,
    "properties": {
        "Country": {
            "type": "string",
            "description": "Country in which the emission factor is valid"
        },
        "Type": {
            "type": "string",
            "description": "Type of resource consumption the emission factor refers to"
        },
        "ValidFrom": {
            "type": "string",
            "description": "Date validity starts e.g: 01.01.19 00:00"
        },
        "ValidUntil": {
            "type": "string",
            "description": "Date validity ends e.g: 31.13.19 23:59"
        },
        "Value": {
            "type": "number",
            "description": "Value of emission factor"
        },
        "Unit": {
            "type": "string",
            "description": "Unit of emission factor in terms of kgCO2e per unit of resource consumption"
        },
        "Source": {
            "type": "string",
            "description": "Source of emission factor e.g. 'International Energy Agency'"
        },
        "SpaceType": {
            "type": "string",
            "description": "Differentiated emission factor for certain space type (within a building)"
        },
        "Region": {
            "type": "string"
        },
        "City": {
            "type": "string"
        },
        "SiteId": {
            "type": "string",
            "description": "Differentiated emission factor for certain site"
        },
        "BuildingId": {
            "type": "string",
            "description": "Differentiated emission factor for certain building"
        },
        "BusinessPartnerId": {
            "type": "string",
            "description": "Identifier of business partner that has entered a user-defined emission factor"
        },
        "OperationalMeasurementGuid": {
            "type": "string",
            "description": "Differentiated emission factor for certain operational measurement"
        },
        "Guid": {
            "type": "string",
            "description": "Globally Unique Identifier number"
        }
    }
}
2.4.2.2.5 EmissionFactor JSON data
{
    "Country": "Lorem",
    "Type": "Lorem",
    "ValidFrom": "Lorem",
    "ValidUntil": "Lorem",
    "Value": -14,
    "Unit": "Lorem",
    "Source": "Lorem",
    "SpaceType": "Lorem",
    "Region": "Lorem",
    "City": "Lorem",
    "SiteId": "Lorem",
    "BuildingId": "Lorem",
    "BusinessPartnerId": "Lorem",
    "OperationalMeasurementGuid": "Lorem",
    "Guid": "Lorem"
}
2.4.2.3 Document OperationalMeasurement
2.4.2.3.1 OperationalMeasurement Tree Diagram
2.4.2.3.2 OperationalMeasurement Properties
PropertyValue
Document nameOperationalMeasurement
Technical name
Activatedtrue
Id
Description
GroupEnergyAndRessources
RESTful API
Additional propertiesfalse
Comments
2.4.2.3.3 OperationalMeasurement Fields
FieldTypeReqKeyDescriptionComments
Guidstringfalse

Globally Unique Identifier number

Parentstringfalse

Parent (Guid) of individual operational measurement

Purposestringfalse

Specific purpose of resource consumption e.g. 'space heating' in case of burning natural gas

Accuracystringfalse

Information on accuracy of value e.g. 'metered' or 'extrapolated'

Typestringfalse

General type of operational measurement e.g. energy, water or waste

SubTypestringfalse

Specific type of operational measurement e.g. district heating or water discharge

Namestringfalse

Name of individual operational measurement. (user-provided)

Valueintegerfalse

Value of individual operational measurement

[{"dataType":"float"}]

Unitstringfalse

Unit of operational measurement e.g. 'kWh' or 'm³'

ProcuredBystringfalse

Information on operational control ('who bought it?') of resource consumption according to Greenhouse Gas Protocol

SpaceTypestringfalse

Reference to specific space type (or 'whole building')

LCAstringfalse

Related life cycle assessment stage according to ISO 14040 e.g. 'B6'

PostingDatestringfalse

Date of measurement posting e.g. 01.01.19 00:00

[{"dataType":"dateTime"}]

MeasurementDatestringfalse

Date of measurement e.g. 01.01.19 00:00

[{"dataType":"dateTime"}]

ValidFromstringfalse

Date validity starts e.g. 01.01.19 00:00

[{"dataType":"dateTime"}]

ValidUntilstringfalse

Date validity end e.g. 01.01.19 00:00

[{"dataType":"dateTime"}]

ProjectionBaseYearstringfalse

Base year of operational value projected into the future

[{"dataType":"dateTime"}]

ProjectionBaseGuidstringfalse

Identifier (Guid) of operational value projected into the future

Identifier (Guid) of operational value projected into the future

MeterNumberintegerfalse

Name of meter providing value (user-provided)

PortfolioIdstringfalse

Identifier of portfolio

SiteIdstringfalse

Identifier of site

LandIdstringfalse

Identifier of land

BuildingIdstringfalse

Identifier of building

FloorIdstringfalse

Identifier of floor

SpaceIdstringfalse

Identifier of space

WorkplaceIdstringfalse

Identifier of workspace

MeterIdstringfalse

Identifier of meter providing value

BusinessPartnerIdstringfalse

Identifier of business partner

2.4.2.3.3.1 Field Parent
2.4.2.3.3.1.1 Parent properties
PropertyValue
Name Parent
Technical name
Activated true
Id
Type string
Description

Parent (Guid) of individual operational measurement

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.2 Field Purpose
2.4.2.3.3.2.1 Purpose properties
PropertyValue
Name Purpose
Technical name
Activated true
Id
Type string
Description

Specific purpose of resource consumption e.g. 'space heating' in case of burning natural gas

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.3 Field Accuracy
2.4.2.3.3.3.1 Accuracy properties
PropertyValue
Name Accuracy
Technical name
Activated true
Id
Type string
Description

Information on accuracy of value e.g. 'metered' or 'extrapolated'

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.4 Field Type
2.4.2.3.3.4.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description

General type of operational measurement e.g. energy, water or waste

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.5 Field SubType
2.4.2.3.3.5.1 SubType properties
PropertyValue
Name SubType
Technical name
Activated true
Id
Type string
Description

Specific type of operational measurement e.g. district heating or water discharge

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.6 Field Name
2.4.2.3.3.6.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description

Name of individual operational measurement. (user-provided)

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.7 Field Value
2.4.2.3.3.7.1 Value properties
PropertyValue
Name Value
Technical name
Activated true
Id
Type integer
Description

Value of individual operational measurement

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.4.2.3.3.8 Field Unit
2.4.2.3.3.8.1 Unit properties
PropertyValue
Name Unit
Technical name
Activated true
Id
Type string
Description

Unit of operational measurement e.g. 'kWh' or 'm³'

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.9 Field ProcuredBy
2.4.2.3.3.9.1 ProcuredBy properties
PropertyValue
Name ProcuredBy
Technical name
Activated true
Id
Type string
Description

Information on operational control ('who bought it?') of resource consumption according to Greenhouse Gas Protocol

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.10 Field SpaceType
2.4.2.3.3.10.1 SpaceType properties
PropertyValue
Name SpaceType
Technical name
Activated true
Id
Type string
Description

Reference to specific space type (or 'whole building')

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.11 Field LCA
2.4.2.3.3.11.1 LCA properties
PropertyValue
Name LCA
Technical name
Activated true
Id
Type string
Description

Related life cycle assessment stage according to ISO 14040 e.g. 'B6'

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.12 Field PostingDate
2.4.2.3.3.12.1 PostingDate properties
PropertyValue
Name PostingDate
Technical name
Activated true
Id
Type string
Description

Date of measurement posting e.g. 01.01.19 00:00

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.4.2.3.3.13 Field MeasurementDate
2.4.2.3.3.13.1 MeasurementDate properties
PropertyValue
Name MeasurementDate
Technical name
Activated true
Id
Type string
Description

Date of measurement e.g. 01.01.19 00:00

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.4.2.3.3.14 Field ValidFrom
2.4.2.3.3.14.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name
Activated true
Id
Type string
Description

Date validity starts e.g. 01.01.19 00:00

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.4.2.3.3.15 Field ValidUntil
2.4.2.3.3.15.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name
Activated true
Id
Type string
Description

Date validity end e.g. 01.01.19 00:00

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.4.2.3.3.16 Field ProjectionBaseYear
2.4.2.3.3.16.1 ProjectionBaseYear properties
PropertyValue
Name ProjectionBaseYear
Technical name
Activated true
Id
Type string
Description

Base year of operational value projected into the future

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.4.2.3.3.17 Field ProjectionBaseGuid
2.4.2.3.3.17.1 ProjectionBaseGuid properties
PropertyValue
Name ProjectionBaseGuid
Technical name
Activated true
Id
Type string
Description

Identifier (Guid) of operational value projected into the future

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

Identifier (Guid) of operational value projected into the future

2.4.2.3.3.18 Field MeterNumber
2.4.2.3.3.18.1 MeterNumber properties
PropertyValue
Name MeterNumber
Technical name
Activated true
Id
Type integer
Description

Name of meter providing value (user-provided)

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.4.2.3.3.19 Field PortfolioId
2.4.2.3.3.19.1 PortfolioId properties
PropertyValue
Name PortfolioId
Technical name
Activated true
Id
Type string
Description

Identifier of portfolio

Dependencies
Required
Primary key false
Foreign collection Portfolio
Foreign field PortfolioId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.20 Field SiteId
2.4.2.3.3.20.1 SiteId properties
PropertyValue
Name SiteId
Technical name
Activated true
Id
Type string
Description

Identifier of site

Dependencies
Required
Primary key
Foreign collection Site
Foreign field SiteId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.21 Field LandId
2.4.2.3.3.21.1 LandId properties
PropertyValue
Name LandId
Technical name
Activated true
Id
Type string
Description

Identifier of land

Dependencies
Required
Primary key false
Foreign collection Land
Foreign field LandId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.22 Field BuildingId
2.4.2.3.3.22.1 BuildingId properties
PropertyValue
Name BuildingId
Technical name
Activated true
Id
Type string
Description

Identifier of building

Dependencies
Required
Primary key false
Foreign collection Building
Foreign field BuildingId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.23 Field FloorId
2.4.2.3.3.23.1 FloorId properties
PropertyValue
Name FloorId
Technical name
Activated true
Id
Type string
Description

Identifier of floor

Dependencies
Required
Primary key false
Foreign collection Floor
Foreign field FloorId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.24 Field SpaceId
2.4.2.3.3.24.1 SpaceId properties
PropertyValue
Name SpaceId
Technical name
Activated true
Id
Type string
Description

Identifier of space

Dependencies
Required
Primary key false
Foreign collection Space
Foreign field SpaceId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.25 Field WorkplaceId
2.4.2.3.3.25.1 WorkplaceId properties
PropertyValue
Name WorkplaceId
Technical name
Activated true
Id
Type string
Description

Identifier of workspace

Dependencies
Required
Primary key false
Foreign collection Workplace
Foreign field WorkplaceId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.26 Field MeterId
2.4.2.3.3.26.1 MeterId properties
PropertyValue
Name MeterId
Technical name
Activated true
Id
Type string
Description

Identifier of meter providing value

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.27 Field BusinessPartnerId
2.4.2.3.3.27.1 BusinessPartnerId properties
PropertyValue
Name BusinessPartnerId
Technical name
Activated true
Id
Type string
Description

Identifier of business partner

Dependencies
Required
Primary key false
Foreign collection BusinessPartner
Foreign field BusinessPartnerId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.3.28 Field Guid
2.4.2.3.3.28.1 Guid properties
PropertyValue
Name Guid
Technical name
Activated true
Id
Type string
Description

Globally Unique Identifier number

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.3.4 OperationalMeasurement JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "OperationalMeasurement",
    "additionalProperties": false,
    "properties": {
        "Parent": {
            "type": "string",
            "description": "Parent (Guid) of individual operational measurement"
        },
        "Purpose": {
            "type": "string",
            "description": "Specific purpose of resource consumption e.g. 'space heating' in case of burning natural gas"
        },
        "Accuracy": {
            "type": "string",
            "description": "Information on accuracy of value e.g. 'metered' or 'extrapolated'"
        },
        "Type": {
            "type": "string",
            "description": "General type of operational measurement e.g. energy, water or waste"
        },
        "SubType": {
            "type": "string",
            "description": "Specific type of operational measurement e.g. district heating or water discharge"
        },
        "Name": {
            "type": "string",
            "description": "Name of individual operational measurement. (user-provided)"
        },
        "Value": {
            "type": "number",
            "description": "Value of individual operational measurement"
        },
        "Unit": {
            "type": "string",
            "description": "Unit of operational measurement e.g. 'kWh' or 'm³'"
        },
        "ProcuredBy": {
            "type": "string",
            "description": "Information on operational control ('who bought it?') of resource consumption according to Greenhouse Gas Protocol"
        },
        "SpaceType": {
            "type": "string",
            "description": "Reference to specific space type (or 'whole building')"
        },
        "LCA": {
            "type": "string",
            "description": "Related life cycle assessment stage according to ISO 14040 e.g. 'B6'"
        },
        "PostingDate": {
            "type": "string",
            "description": "Date of measurement posting e.g. 01.01.19 00:00"
        },
        "MeasurementDate": {
            "type": "string",
            "description": "Date of measurement e.g. 01.01.19 00:00"
        },
        "ValidFrom": {
            "type": "string",
            "description": "Date validity starts e.g. 01.01.19 00:00"
        },
        "ValidUntil": {
            "type": "string",
            "description": "Date validity end e.g. 01.01.19 00:00"
        },
        "ProjectionBaseYear": {
            "type": "string",
            "description": "Base year of operational value projected into the future"
        },
        "ProjectionBaseGuid": {
            "type": "string",
            "description": "Identifier (Guid) of operational value projected into the future"
        },
        "MeterNumber": {
            "type": "number",
            "description": "Name of meter providing value (user-provided)"
        },
        "PortfolioId": {
            "type": "string",
            "description": "Identifier of portfolio"
        },
        "SiteId": {
            "type": "string",
            "description": "Identifier of site"
        },
        "LandId": {
            "type": "string",
            "description": "Identifier of land"
        },
        "BuildingId": {
            "type": "string",
            "description": "Identifier of building"
        },
        "FloorId": {
            "type": "string",
            "description": "Identifier of floor"
        },
        "SpaceId": {
            "type": "string",
            "description": "Identifier of space"
        },
        "WorkplaceId": {
            "type": "string",
            "description": "Identifier of workspace"
        },
        "MeterId": {
            "type": "string",
            "description": "Identifier of meter providing value"
        },
        "BusinessPartnerId": {
            "type": "string",
            "description": "Identifier of business partner"
        },
        "Guid": {
            "type": "string",
            "description": "Globally Unique Identifier number"
        }
    }
}
2.4.2.3.5 OperationalMeasurement JSON data
{
    "Parent": "Lorem",
    "Purpose": "Lorem",
    "Accuracy": "Lorem",
    "Type": "Lorem",
    "SubType": "Lorem",
    "Name": "Lorem",
    "Value": -91,
    "Unit": "Lorem",
    "ProcuredBy": "Lorem",
    "SpaceType": "Lorem",
    "LCA": "Lorem",
    "PostingDate": "Lorem",
    "MeasurementDate": "Lorem",
    "ValidFrom": "Lorem",
    "ValidUntil": "Lorem",
    "ProjectionBaseYear": "Lorem",
    "ProjectionBaseGuid": "Lorem",
    "MeterNumber": 75,
    "PortfolioId": "Lorem",
    "SiteId": "Lorem",
    "LandId": "Lorem",
    "BuildingId": "Lorem",
    "FloorId": "Lorem",
    "SpaceId": "Lorem",
    "WorkplaceId": "Lorem",
    "MeterId": "Lorem",
    "BusinessPartnerId": "Lorem",
    "Guid": "Lorem"
}
2.4.2.4 Document SustainabilityIndicators
2.4.2.4.1 SustainabilityIndicators Tree Diagram
2.4.2.4.2 SustainabilityIndicators Properties
PropertyValue
Document nameSustainabilityIndicators
Technical name
Activatedtrue
Id
Description
GroupEnergyAndRessources
RESTful API
Additional properties
Comments
2.4.2.4.3 SustainabilityIndicators Fields
FieldTypeReqKeyDescriptionComments
Guidstringfalse

Globally Unique Identifier number

Categorystringfalse

Overall category of sustainability indicator e.g. energy, greenhouse gas emissions or costs

Typestringfalse

Type of sustainability indicator e.g. absolute or intensity figures or stranding

Subtypestringfalse

Subtype of sustainability indicator e.g. net-energy or emission scope

Sourcestringfalse

Operational source of energy or emission figures e.g. electricity or water

ReferenceAreastringfalse

Reference area of building used as denominator in intensity calculation

ReportingTypestringfalse

Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based

BaseYearstringfalse

Base year of values projected into the future

[{"dataType":"dateTime"}]

Valuenumberfalse

Value of sustainability indicator

[{"dataType":"float"}]

Unitstringfalse

Unit of sustainability indicator value

ValidFromstringfalse

Date validity starts e.g. 01.01.19 00:00

[{"dataType":"dateTime"}]

ValidUntilstringfalse

Date validity end e.g. 01.01.19 00:00

[{"dataType":"dateTime"}]

BuildingIdstringfalse

Identifier of building

2.4.2.4.3.1 Field Category
2.4.2.4.3.1.1 Category properties
PropertyValue
Name Category
Technical name
Activated true
Id
Type string
Description

Overall category of sustainability indicator e.g. energy, greenhouse gas emissions or costs

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.4.3.2 Field Type
2.4.2.4.3.2.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description

Type of sustainability indicator e.g. absolute or intensity figures or stranding

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.4.3.3 Field Subtype
2.4.2.4.3.3.1 Subtype properties
PropertyValue
Name Subtype
Technical name
Activated true
Id
Type string
Description

Subtype of sustainability indicator e.g. net-energy or emission scope

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.4.3.4 Field Source
2.4.2.4.3.4.1 Source properties
PropertyValue
Name Source
Technical name
Activated true
Id
Type string
Description

Operational source of energy or emission figures e.g. electricity or water

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.4.3.5 Field ReferenceArea
2.4.2.4.3.5.1 ReferenceArea properties
PropertyValue
Name ReferenceArea
Technical name
Activated true
Id
Type string
Description

Reference area of building used as denominator in intensity calculation

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.4.3.6 Field ReportingType
2.4.2.4.3.6.1 ReportingType properties
PropertyValue
Name ReportingType
Technical name
Activated true
Id
Type string
Description

Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.4.3.7 Field BaseYear
2.4.2.4.3.7.1 BaseYear properties
PropertyValue
Name BaseYear
Technical name
Activated true
Id
Type string
Description

Base year of values projected into the future

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.4.2.4.3.8 Field Value
2.4.2.4.3.8.1 Value properties
PropertyValue
Name Value
Technical name
Activated true
Id
Type number
Description

Value of sustainability indicator

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.4.2.4.3.9 Field Unit
2.4.2.4.3.9.1 Unit properties
PropertyValue
Name Unit
Technical name
Activated true
Id
Type string
Description

Unit of sustainability indicator value

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.4.3.10 Field ValidFrom
2.4.2.4.3.10.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name
Activated true
Id
Type string
Description

Date validity starts e.g. 01.01.19 00:00

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.4.2.4.3.11 Field ValidUntil
2.4.2.4.3.11.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name
Activated true
Id
Type string
Description

Date validity end e.g. 01.01.19 00:00

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.4.2.4.3.12 Field BuildingId
2.4.2.4.3.12.1 BuildingId properties
PropertyValue
Name BuildingId
Technical name
Activated true
Id
Type string
Description

Identifier of building

Dependencies
Required
Primary key
Foreign collection Building
Foreign field BuildingId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.4.3.13 Field Guid
2.4.2.4.3.13.1 Guid properties
PropertyValue
Name Guid
Technical name
Activated true
Id
Type string
Description

Globally Unique Identifier number

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.4.4 SustainabilityIndicators JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "SustainabilityIndicators",
    "properties": {
        "Category": {
            "type": "string",
            "description": "Overall category of sustainability indicator e.g. energy, greenhouse gas emissions or costs"
        },
        "Type": {
            "type": "string",
            "description": "Type of sustainability indicator e.g. absolute or intensity figures or stranding"
        },
        "Subtype": {
            "type": "string",
            "description": "Subtype of sustainability indicator e.g. net-energy or  emission scope"
        },
        "Source": {
            "type": "string",
            "description": "Operational source of energy or emission figures e.g. electricity or water"
        },
        "ReferenceArea": {
            "type": "string",
            "description": "Reference area of building used as denominator in intensity calculation"
        },
        "ReportingType": {
            "type": "string",
            "description": "Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based"
        },
        "BaseYear": {
            "type": "string",
            "description": "Base year of values projected into the future"
        },
        "Value": {
            "type": "number",
            "description": "Value of sustainability indicator"
        },
        "Unit": {
            "type": "string",
            "description": "Unit of sustainability indicator value"
        },
        "ValidFrom": {
            "type": "string",
            "description": "Date validity starts e.g. 01.01.19 00:00"
        },
        "ValidUntil": {
            "type": "string",
            "description": "Date validity end e.g. 01.01.19 00:00"
        },
        "BuildingId": {
            "type": "string",
            "description": "Identifier of building"
        },
        "Guid": {
            "type": "string",
            "description": "Globally Unique Identifier number"
        }
    }
}
2.4.2.4.5 SustainabilityIndicators JSON data
{
    "Category": "Lorem",
    "Type": "Lorem",
    "Subtype": "Lorem",
    "Source": "Lorem",
    "ReferenceArea": "Lorem",
    "ReportingType": "Lorem",
    "BaseYear": "Lorem",
    "Value": -98,
    "Unit": "Lorem",
    "ValidFrom": "Lorem",
    "ValidUntil": "Lorem",
    "BuildingId": "Lorem",
    "Guid": "Lorem"
}
2.4.2.5 Document SustainabilityTargets
2.4.2.5.1 SustainabilityTargets Tree Diagram
2.4.2.5.2 SustainabilityTargets Properties
PropertyValue
Document nameSustainabilityTargets
Technical name
Activatedtrue
Id
Description
GroupEnergyAndRessources
RESTful API
Additional propertiesfalse
Comments
2.4.2.5.3 SustainabilityTargets Fields
FieldTypeReqKeyDescriptionComments
Guidstringfalse

Globally Unique Identifier number

Typestringfalse

Overall type of target e.g. energy or carbon

SubTypestringfalse

Subtype of target e.g. 1.5DC or 2.0DC

BuildingTypestringfalse

Type of building e.g. residential multi-family

Standardstringfalse

Underlying standard of target e.g. CRREM

Namestringfalse

Name of individual target (user-provided)

Valuenumberfalse

Value of sustainability target

[{"dataType":"float"}]

Unitstringfalse

Unit of sustainability target value e.g. kWh/m²

ValidFromstringfalse

Date validity starts e.g. 01.01.19 00:00

[{"dataType":"dateTime"}]

ValidUntilstringfalse

Date validity end e.g. 01.01.19 00:00

[{"dataType":"dateTime"}]

Countrystringfalse

Country in which the sustainability target is valid

2.4.2.5.3.1 Field Type
2.4.2.5.3.1.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description

Overall type of target e.g. energy or carbon

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.5.3.2 Field SubType
2.4.2.5.3.2.1 SubType properties
PropertyValue
Name SubType
Technical name
Activated true
Id
Type string
Description

Subtype of target e.g. 1.5DC or 2.0DC

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.5.3.3 Field BuildingType
2.4.2.5.3.3.1 BuildingType properties
PropertyValue
Name BuildingType
Technical name
Activated true
Id
Type string
Description

Type of building e.g. residential multi-family

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.5.3.4 Field Standard
2.4.2.5.3.4.1 Standard properties
PropertyValue
Name Standard
Technical name
Activated true
Id
Type string
Description

Underlying standard of target e.g. CRREM

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.5.3.5 Field Name
2.4.2.5.3.5.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description

Name of individual target (user-provided)

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.5.3.6 Field Value
2.4.2.5.3.6.1 Value properties
PropertyValue
Name Value
Technical name
Activated true
Id
Type number
Description

Value of sustainability target

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.4.2.5.3.7 Field Unit
2.4.2.5.3.7.1 Unit properties
PropertyValue
Name Unit
Technical name
Activated true
Id
Type string
Description

Unit of sustainability target value e.g. kWh/m²

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.5.3.8 Field ValidFrom
2.4.2.5.3.8.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name
Activated true
Id
Type string
Description

Date validity starts e.g. 01.01.19 00:00

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.4.2.5.3.9 Field ValidUntil
2.4.2.5.3.9.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name
Activated true
Id
Type string
Description

Date validity end e.g. 01.01.19 00:00

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.4.2.5.3.10 Field Country
2.4.2.5.3.10.1 Country properties
PropertyValue
Name Country
Technical name
Activated true
Id
Type string
Description

Country in which the sustainability target is valid

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.5.3.11 Field Guid
2.4.2.5.3.11.1 Guid properties
PropertyValue
Name Guid
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

Globally Unique Identifier number

2.4.2.5.4 SustainabilityTargets JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "SustainabilityTargets",
    "additionalProperties": false,
    "properties": {
        "Type": {
            "type": "string",
            "description": "Overall type of target e.g. energy or carbon"
        },
        "SubType": {
            "type": "string",
            "description": "Subtype of target e.g. 1.5DC or 2.0DC"
        },
        "BuildingType": {
            "type": "string",
            "description": "Type of building e.g. residential multi-family"
        },
        "Standard": {
            "type": "string",
            "description": "Underlying standard of target e.g. CRREM"
        },
        "Name": {
            "type": "string",
            "description": "Name of individual target (user-provided)"
        },
        "Value": {
            "type": "number",
            "description": "Value of sustainability target"
        },
        "Unit": {
            "type": "string",
            "description": "Unit of sustainability target value e.g. kWh/m²"
        },
        "ValidFrom": {
            "type": "string",
            "description": "Date validity starts e.g. 01.01.19 00:00"
        },
        "ValidUntil": {
            "type": "string",
            "description": "Date validity end e.g. 01.01.19 00:00"
        },
        "Country": {
            "type": "string",
            "description": "Country in which the sustainability target is valid"
        },
        "Guid": {
            "type": "string"
        }
    }
}
2.4.2.5.5 SustainabilityTargets JSON data
{
    "Type": "Lorem",
    "SubType": "Lorem",
    "BuildingType": "Lorem",
    "Standard": "Lorem",
    "Name": "Lorem",
    "Value": 13,
    "Unit": "Lorem",
    "ValidFrom": "Lorem",
    "ValidUntil": "Lorem",
    "Country": "Lorem",
    "Guid": "Lorem"
}
2.4.2.6 Document gHgEmissions
2.4.2.6.1 gHgEmissions Tree Diagram
2.4.2.6.2 gHgEmissions Properties
PropertyValue
Document namegHgEmissions
Technical name
Activatedtrue
Id
Description
GroupEnergyAndRessources
RESTful API
Additional propertiesfalse
Comments
2.4.2.6.3 gHgEmissions Fields
FieldTypeReqKeyDescriptionComments
Guidstringfalse

Globally Unique Identifier number

Titlestringfalse

Name of individual emission value (user-provided)

Parentstringfalse

Parent (Guid) of individual emission value

EmissionScopestringfalse

Emission scope 1, 2 or 3 according to the Greenhouse Gas Protocol

ReportingTypestringfalse

Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based

Typestringfalse

General source of emission e.g. energy, water or waste

SubTypestringfalse

Specific source of emission e.g. district heating or water discharge

LCAstringfalse

Related life cycle assessment stage according to ISO 14040 e.g. 'B6'

ProjectionBaseYearstringfalse

Base year of emissions projected into the future

[{"dataType":"dateTime"}]

ValidFromstringfalse

Date validity starts e.g. 01.01.19 00:00

[{"dataType":"dateTime"}]

ValidUntilstringfalse

Date validity end e.g. 01.01.19 00:00

[{"dataType":"dateTime"}]

Valuenumberfalse

Value of individual emission

[{"dataType":"float"}]

Unitstringfalse

Unit of emission value: kgCO2e

BasedOnUserEmissionstringfalse

Indication whether emission value is based on user-provided emission factor (Y/N/NA)

Accuracystringfalse

Information on accuracy of value e.g. 'metered' or 'extrapolated'

SiteIdstringfalse

Identifier (Guid) of related site

BuildingIdstringfalse
OperationalMeasurementGuidstringfalse
2.4.2.6.3.1 Field Title
2.4.2.6.3.1.1 Title properties
PropertyValue
Name Title
Technical name
Activated true
Id
Type string
Description

Name of individual emission value (user-provided)

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.6.3.2 Field Parent
2.4.2.6.3.2.1 Parent properties
PropertyValue
Name Parent
Technical name
Activated true
Id
Type string
Description

Parent (Guid) of individual emission value

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.6.3.3 Field EmissionScope
2.4.2.6.3.3.1 EmissionScope properties
PropertyValue
Name EmissionScope
Technical name
Activated true
Id
Type string
Description

Emission scope 1, 2 or 3 according to the Greenhouse Gas Protocol

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.6.3.4 Field ReportingType
2.4.2.6.3.4.1 ReportingType properties
PropertyValue
Name ReportingType
Technical name
Activated true
Id
Type string
Description

Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.6.3.5 Field Type
2.4.2.6.3.5.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description

General source of emission e.g. energy, water or waste

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.6.3.6 Field SubType
2.4.2.6.3.6.1 SubType properties
PropertyValue
Name SubType
Technical name
Activated true
Id
Type string
Description

Specific source of emission e.g. district heating or water discharge

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.6.3.7 Field LCA
2.4.2.6.3.7.1 LCA properties
PropertyValue
Name LCA
Technical name
Activated true
Id
Type string
Description

Related life cycle assessment stage according to ISO 14040 e.g. 'B6'

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.6.3.8 Field ProjectionBaseYear
2.4.2.6.3.8.1 ProjectionBaseYear properties
PropertyValue
Name ProjectionBaseYear
Technical name
Activated true
Id
Type string
Description

Base year of emissions projected into the future

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.4.2.6.3.9 Field ValidFrom
2.4.2.6.3.9.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name
Activated true
Id
Type string
Description

Date validity starts e.g. 01.01.19 00:00

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.4.2.6.3.10 Field ValidUntil
2.4.2.6.3.10.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name
Activated true
Id
Type string
Description

Date validity end e.g. 01.01.19 00:00

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.4.2.6.3.11 Field Value
2.4.2.6.3.11.1 Value properties
PropertyValue
Name Value
Technical name
Activated true
Id
Type number
Description

Value of individual emission

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.4.2.6.3.12 Field Unit
2.4.2.6.3.12.1 Unit properties
PropertyValue
Name Unit
Technical name
Activated true
Id
Type string
Description

Unit of emission value: kgCO2e

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.6.3.13 Field BasedOnUserEmission
2.4.2.6.3.13.1 BasedOnUserEmission properties
PropertyValue
Name BasedOnUserEmission
Technical name
Activated true
Id
Type string
Description

Indication whether emission value is based on user-provided emission factor (Y/N/NA)

Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.6.3.14 Field Accuracy
2.4.2.6.3.14.1 Accuracy properties
PropertyValue
Name Accuracy
Technical name
Activated true
Id
Type string
Description

Information on accuracy of value e.g. 'metered' or 'extrapolated'

Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.6.3.15 Field SiteId
2.4.2.6.3.15.1 SiteId properties
PropertyValue
Name SiteId
Technical name
Activated true
Id
Type string
Description

Identifier (Guid) of related site

Dependencies
Required
Primary key
Foreign collection Site
Foreign field SiteId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.6.3.16 Field BuildingId
2.4.2.6.3.16.1 BuildingId properties
PropertyValue
Name BuildingId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection Building
Foreign field BuildingId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.6.3.17 Field OperationalMeasurementGuid
2.4.2.6.3.17.1 OperationalMeasurementGuid properties
PropertyValue
Name OperationalMeasurementGuid
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection OperationalMeasurement
Foreign field Guid
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.6.3.18 Field Guid
2.4.2.6.3.18.1 Guid properties
PropertyValue
Name Guid
Technical name
Activated true
Id
Type string
Description

Globally Unique Identifier number

Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.4.2.6.4 gHgEmissions JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "gHgEmissions",
    "additionalProperties": false,
    "properties": {
        "Title": {
            "type": "string",
            "description": "Name of individual emission value (user-provided)"
        },
        "Parent": {
            "type": "string",
            "description": "Parent (Guid) of individual emission value"
        },
        "EmissionScope": {
            "type": "string",
            "description": "Emission scope 1, 2 or 3 according to the Greenhouse Gas Protocol"
        },
        "ReportingType": {
            "type": "string",
            "description": "Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based"
        },
        "Type": {
            "type": "string",
            "description": "General source of emission e.g. energy, water or waste"
        },
        "SubType": {
            "type": "string",
            "description": "Specific source of emission e.g. district heating or water discharge"
        },
        "LCA": {
            "type": "string",
            "description": "Related life cycle assessment stage according to ISO 14040 e.g. 'B6'"
        },
        "ProjectionBaseYear": {
            "type": "string",
            "description": "Base year of emissions projected into the future"
        },
        "ValidFrom": {
            "type": "string",
            "description": "Date validity starts e.g. 01.01.19 00:00"
        },
        "ValidUntil": {
            "type": "string",
            "description": "Date validity end e.g. 01.01.19 00:00"
        },
        "Value": {
            "type": "number",
            "description": "Value of individual emission"
        },
        "Unit": {
            "type": "string",
            "description": "Unit of emission value: kgCO2e"
        },
        "BasedOnUserEmission": {
            "type": "string",
            "description": "Indication whether emission value is based on user-provided emission factor (Y/N/NA)"
        },
        "Accuracy": {
            "type": "string",
            "description": "Information on accuracy of value e.g. 'metered' or 'extrapolated'"
        },
        "SiteId": {
            "type": "string",
            "description": "Identifier (Guid) of related site"
        },
        "BuildingId": {
            "type": "string"
        },
        "OperationalMeasurementGuid": {
            "type": "string"
        },
        "Guid": {
            "type": "string",
            "description": "Globally Unique Identifier number"
        }
    }
}
2.4.2.6.5 gHgEmissions JSON data
{
    "Title": "Lorem",
    "Parent": "Lorem",
    "EmissionScope": "Lorem",
    "ReportingType": "Lorem",
    "Type": "Lorem",
    "SubType": "Lorem",
    "LCA": "Lorem",
    "ProjectionBaseYear": "Lorem",
    "ValidFrom": "Lorem",
    "ValidUntil": "Lorem",
    "Value": 46,
    "Unit": "Lorem",
    "BasedOnUserEmission": "Lorem",
    "Accuracy": "Lorem",
    "SiteId": "Lorem",
    "BuildingId": "Lorem",
    "OperationalMeasurementGuid": "Lorem",
    "Guid": "Lorem"
}
2.5 Group Facility Management
2.5.1 Facility Management Properties
PropertyValue
Group nameFacility Management
Technical name
Activatedtrue
Description
Comments
2.5.2 Facility Management Documents
2.5.2.1 Document EquipmentMonitoring
2.5.2.1.1 EquipmentMonitoring Tree Diagram
2.5.2.1.2 EquipmentMonitoring Properties
PropertyValue
Document nameEquipmentMonitoring
Technical name
Activatedtrue
Id
Description
GroupFacility Management
RESTful API
Additional propertiesfalse
Comments
2.5.2.1.3 EquipmentMonitoring Fields
FieldTypeReqKeyDescriptionComments
EquipmentIdstringfalse
EquipmentUtilisationstringfalse
EquipmentServicestringfalse
EquipmentStatusstringfalse
RootCausestringfalse
Valuenumberfalse
Unitstringfalse
BuildingIdstringfalse
ActivityIdstringfalse
2.5.2.1.3.1 Field EquipmentId
2.5.2.1.3.1.1 EquipmentId properties
PropertyValue
Name EquipmentId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.5.2.1.3.2 Field EquipmentUtilisation
2.5.2.1.3.2.1 EquipmentUtilisation properties
PropertyValue
Name EquipmentUtilisation
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.5.2.1.3.3 Field EquipmentService
2.5.2.1.3.3.1 EquipmentService properties
PropertyValue
Name EquipmentService
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.5.2.1.3.4 Field EquipmentStatus
2.5.2.1.3.4.1 EquipmentStatus properties
PropertyValue
Name EquipmentStatus
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.5.2.1.3.5 Field RootCause
2.5.2.1.3.5.1 RootCause properties
PropertyValue
Name RootCause
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.5.2.1.3.6 Field Value
2.5.2.1.3.6.1 Value properties
PropertyValue
Name Value
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.5.2.1.3.7 Field Unit
2.5.2.1.3.7.1 Unit properties
PropertyValue
Name Unit
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.5.2.1.3.8 Field BuildingId
2.5.2.1.3.8.1 BuildingId properties
PropertyValue
Name BuildingId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.5.2.1.3.9 Field ActivityId
2.5.2.1.3.9.1 ActivityId properties
PropertyValue
Name ActivityId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.5.2.1.4 EquipmentMonitoring JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "EquipmentMonitoring",
    "additionalProperties": false,
    "properties": {
        "EquipmentId": {
            "type": "string"
        },
        "EquipmentUtilisation": {
            "type": "string"
        },
        "EquipmentService": {
            "type": "string"
        },
        "EquipmentStatus": {
            "type": "string"
        },
        "RootCause": {
            "type": "string"
        },
        "Value": {
            "type": "number"
        },
        "Unit": {
            "type": "string"
        },
        "BuildingId": {
            "type": "string"
        },
        "ActivityId": {
            "type": "string"
        }
    }
}
2.5.2.1.5 EquipmentMonitoring JSON data
{
    "EquipmentId": "Lorem",
    "EquipmentUtilisation": "Lorem",
    "EquipmentService": "Lorem",
    "EquipmentStatus": "Lorem",
    "RootCause": "Lorem",
    "Value": -44,
    "Unit": "Lorem",
    "BuildingId": "Lorem",
    "ActivityId": "Lorem"
}
2.5.2.2 Document InspectionData
2.5.2.2.1 InspectionData Tree Diagram
2.5.2.2.2 InspectionData Properties
PropertyValue
Document nameInspectionData
Technical name
Activatedtrue
Id
Description
GroupFacility Management
RESTful API
Additional propertiesfalse
Comments
2.5.2.2.3 InspectionData Fields
FieldTypeReqKeyDescriptionComments
InspectIdstringfalse
2.5.2.2.3.1 Field InspectId
2.5.2.2.3.1.1 InspectId properties
PropertyValue
Name InspectId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.5.2.2.4 InspectionData JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "InspectionData",
    "additionalProperties": false,
    "properties": {
        "InspectId": {
            "type": "string"
        }
    }
}
2.5.2.2.5 InspectionData JSON data
{
    "InspectId": "Lorem"
}
2.5.2.3 Document MaintenancePlan
2.5.2.3.1 MaintenancePlan Tree Diagram
2.5.2.3.2 MaintenancePlan Properties
PropertyValue
Document nameMaintenancePlan
Technical name
Activatedtrue
Id
Description
GroupFacility Management
RESTful API
Additional propertiesfalse
Comments
2.5.2.3.3 MaintenancePlan Fields
FieldTypeReqKeyDescriptionComments
PlanIdstringfalse
2.5.2.3.3.1 Field PlanId
2.5.2.3.3.1.1 PlanId properties
PropertyValue
Name PlanId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.5.2.3.4 MaintenancePlan JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "MaintenancePlan",
    "additionalProperties": false,
    "properties": {
        "PlanId": {
            "type": "string"
        }
    }
}
2.5.2.3.5 MaintenancePlan JSON data
{
    "PlanId": "Lorem"
}
2.5.2.4 Document ObjectStatusStrategy
2.5.2.4.1 ObjectStatusStrategy Tree Diagram
2.5.2.4.2 ObjectStatusStrategy Properties
PropertyValue
Document nameObjectStatusStrategy
Technical name
Activatedtrue
Id
Description
GroupFacility Management
RESTful API
Additional propertiesfalse
Comments
2.5.2.4.3 ObjectStatusStrategy Fields
FieldTypeReqKeyDescriptionComments
StatusIdstringfalse
2.5.2.4.3.1 Field StatusId
2.5.2.4.3.1.1 StatusId properties
PropertyValue
Name StatusId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.5.2.4.4 ObjectStatusStrategy JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "ObjectStatusStrategy",
    "additionalProperties": false,
    "properties": {
        "StatusId": {
            "type": "string"
        }
    }
}
2.5.2.4.5 ObjectStatusStrategy JSON data
{
    "StatusId": "Lorem"
}
2.5.2.5 Document TicketsNotification
2.5.2.5.1 TicketsNotification Tree Diagram
2.5.2.5.2 TicketsNotification Properties
PropertyValue
Document nameTicketsNotification
Technical name
Activatedtrue
Id
Description
GroupFacility Management
RESTful API
Additional propertiesfalse
Comments
2.5.2.5.3 TicketsNotification Fields
FieldTypeReqKeyDescriptionComments
NotificationIdstringfalse
2.5.2.5.3.1 Field NotificationId
2.5.2.5.3.1.1 NotificationId properties
PropertyValue
Name NotificationId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.5.2.5.4 TicketsNotification JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "TicketsNotification",
    "additionalProperties": false,
    "properties": {
        "NotificationId": {
            "type": "string"
        }
    }
}
2.5.2.5.5 TicketsNotification JSON data
{
    "NotificationId": "Lorem"
}
2.6 Group Financials
2.6.1 Financials Properties
PropertyValue
Group nameFinancials
Technical name
Activatedtrue
Description
Comments
2.6.2 Financials Documents
2.6.2.1 Document Account
2.6.2.1.1 Account Tree Diagram
2.6.2.1.2 Account Properties
PropertyValue
Document nameAccount
Technical name
Activatedtrue
Id
Description
GroupFinancials
RESTful API
Additional propertiesfalse
Comments
2.6.2.1.3 Account Fields
FieldTypeReqKeyDescriptionComments
AccountIdstringfalse
Namestringfalse
Categorystringfalse
2.6.2.1.3.1 Field AccountId
2.6.2.1.3.1.1 AccountId properties
PropertyValue
Name AccountId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.1.3.2 Field Name
2.6.2.1.3.2.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.1.3.3 Field Category
2.6.2.1.3.3.1 Category properties
PropertyValue
Name Category
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum Income,Expenses,Revenue,Asset,Liabilities,OffsetAccount
Sample
Comments
2.6.2.1.4 Account JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Account",
    "additionalProperties": false,
    "properties": {
        "AccountId": {
            "type": "string"
        },
        "Name": {
            "type": "string"
        },
        "Category": {
            "type": "string",
            "enum": [
                "Income",
                "Expenses",
                "Revenue",
                "Asset",
                "Liabilities",
                "OffsetAccount"
            ]
        }
    }
}
2.6.2.1.5 Account JSON data
{
    "AccountId": "Lorem",
    "Name": "Lorem",
    "Category": "OffsetAccount"
}
2.6.2.2 Document Budget
2.6.2.2.1 Budget Tree Diagram
2.6.2.2.2 Budget Properties
PropertyValue
Document nameBudget
Technical name
Activatedtrue
Id
Description
GroupFinancials
RESTful API
Additional propertiesfalse
Comments
2.6.2.2.3 Budget Fields
FieldTypeReqKeyDescriptionComments
BudgetIdstringfalse
Typestringfalse
2.6.2.2.3.1 Field BudgetId
2.6.2.2.3.1.1 BudgetId properties
PropertyValue
Name BudgetId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.2.3.2 Field Type
2.6.2.2.3.2.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.2.4 Budget JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Budget",
    "additionalProperties": false,
    "properties": {
        "BudgetId": {
            "type": "string"
        },
        "Type": {
            "type": "string"
        }
    }
}
2.6.2.2.5 Budget JSON data
{
    "BudgetId": "Lorem",
    "Type": "Lorem"
}
2.6.2.3 Document CostObject
2.6.2.3.1 CostObject Tree Diagram
2.6.2.3.2 CostObject Properties
PropertyValue
Document nameCostObject
Technical name
Activatedtrue
Id
Description
GroupFinancials
RESTful API
Additional propertiesfalse
Comments

The Entity for Cost Center

2.6.2.3.3 CostObject Fields
FieldTypeReqKeyDescriptionComments
CostObjectIdIdstringfalse
Namestringfalse
Typestringfalse
Valuestringfalse
PortfolioIdstringfalse
SiteIdstringfalse
BuildingIdstringfalse
2.6.2.3.3.1 Field CostObjectIdId
2.6.2.3.3.1.1 CostObjectIdId properties
PropertyValue
Name CostObjectIdId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.3.3.2 Field Name
2.6.2.3.3.2.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.3.3.3 Field Type
2.6.2.3.3.3.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.3.3.4 Field Value
2.6.2.3.3.4.1 Value properties
PropertyValue
Name Value
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.3.3.5 Field PortfolioId
2.6.2.3.3.5.1 PortfolioId properties
PropertyValue
Name PortfolioId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.3.3.6 Field SiteId
2.6.2.3.3.6.1 SiteId properties
PropertyValue
Name SiteId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.3.3.7 Field BuildingId
2.6.2.3.3.7.1 BuildingId properties
PropertyValue
Name BuildingId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.3.4 CostObject JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "CostObject",
    "additionalProperties": false,
    "properties": {
        "CostObjectIdId": {
            "type": "string"
        },
        "Name": {
            "type": "string"
        },
        "Type": {
            "type": "string"
        },
        "Value": {
            "type": "string"
        },
        "PortfolioId": {
            "type": "string"
        },
        "SiteId": {
            "type": "string"
        },
        "BuildingId": {
            "type": "string"
        }
    }
}
2.6.2.3.5 CostObject JSON data
{
    "CostObjectIdId": "Lorem",
    "Name": "Lorem",
    "Type": "Lorem",
    "Value": "Lorem",
    "PortfolioId": "Lorem",
    "SiteId": "Lorem",
    "BuildingId": "Lorem"
}
2.6.2.4 Document CostTransaction
2.6.2.4.1 CostTransaction Tree Diagram
2.6.2.4.2 CostTransaction Properties
PropertyValue
Document nameCostTransaction
Technical nameCstTrnsctn
Activatedtrue
Id
Description
GroupFinancials
RESTful API
Additional propertiesfalse
Comments
2.6.2.4.3 CostTransaction Fields
FieldTypeReqKeyDescriptionComments
TransactionIdstringfalse
PostingDatestringfalse

[{ "dataType":"DateTime"}]

CostObjectIdstringfalse
CostGroupIdstringfalse
CostCategoryIdstringfalse
CostTypeIdstringfalse
CostElementIdstringfalse
CostValuenumberfalse
Currencystringfalse
DocumentIdstringfalse
AccountIdstringfalse
2.6.2.4.3.1 Field TransactionId
2.6.2.4.3.1.1 TransactionId properties
PropertyValue
Name TransactionId
Technical name Trnsctnd
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.4.3.2 Field PostingDate
2.6.2.4.3.2.1 PostingDate properties
PropertyValue
Name PostingDate
Technical name PstngDt
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{ "dataType":"DateTime"}]

2.6.2.4.3.3 Field CostObjectId
2.6.2.4.3.3.1 CostObjectId properties
PropertyValue
Name CostObjectId
Technical name Cstbjctd
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.4.3.4 Field CostGroupId
2.6.2.4.3.4.1 CostGroupId properties
PropertyValue
Name CostGroupId
Technical name CstGrpd
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.4.3.5 Field CostCategoryId
2.6.2.4.3.5.1 CostCategoryId properties
PropertyValue
Name CostCategoryId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.4.3.6 Field CostTypeId
2.6.2.4.3.6.1 CostTypeId properties
PropertyValue
Name CostTypeId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.4.3.7 Field CostElementId
2.6.2.4.3.7.1 CostElementId properties
PropertyValue
Name CostElementId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.4.3.8 Field CostValue
2.6.2.4.3.8.1 CostValue properties
PropertyValue
Name CostValue
Technical name CstVl
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.6.2.4.3.9 Field Currency
2.6.2.4.3.9.1 Currency properties
PropertyValue
Name Currency
Technical name Crrncy
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.4.3.10 Field DocumentId
2.6.2.4.3.10.1 DocumentId properties
PropertyValue
Name DocumentId
Technical name Dcmntd
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.4.3.11 Field AccountId
2.6.2.4.3.11.1 AccountId properties
PropertyValue
Name AccountId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.4.4 CostTransaction JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "CostTransaction",
    "additionalProperties": false,
    "properties": {
        "Trnsctnd": {
            "type": "string"
        },
        "PstngDt": {
            "type": "string"
        },
        "Cstbjctd": {
            "type": "string"
        },
        "CstGrpd": {
            "type": "string"
        },
        "CostCategoryId": {
            "type": "string"
        },
        "CostTypeId": {
            "type": "string"
        },
        "CostElementId": {
            "type": "string"
        },
        "CstVl": {
            "type": "number"
        },
        "Crrncy": {
            "type": "string"
        },
        "Dcmntd": {
            "type": "string"
        },
        "AccountId": {
            "type": "string"
        }
    }
}
2.6.2.4.5 CostTransaction JSON data
{
    "Trnsctnd": "Lorem",
    "PstngDt": "Lorem",
    "Cstbjctd": "Lorem",
    "CstGrpd": "Lorem",
    "CostCategoryId": "Lorem",
    "CostTypeId": "Lorem",
    "CostElementId": "Lorem",
    "CstVl": -33,
    "Crrncy": "Lorem",
    "Dcmntd": "Lorem",
    "AccountId": "Lorem"
}
2.6.2.5 Document Invoicing
2.6.2.5.1 Invoicing Tree Diagram
2.6.2.5.2 Invoicing Properties
PropertyValue
Document nameInvoicing
Technical name
Activatedtrue
Id
Description
GroupFinancials
RESTful API
Additional propertiesfalse
Comments
2.6.2.5.3 Invoicing Fields
FieldTypeReqKeyDescriptionComments
InvoiceIdstringfalse
Vatstringfalse
2.6.2.5.3.1 Field Vat
2.6.2.5.3.1.1 Vat properties
PropertyValue
Name Vat
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.5.3.2 Field InvoiceId
2.6.2.5.3.2.1 InvoiceId properties
PropertyValue
Name InvoiceId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.6.2.5.4 Invoicing JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Invoicing",
    "additionalProperties": false,
    "properties": {
        "Vat": {
            "type": "string"
        },
        "InvoiceId": {
            "type": "string"
        }
    }
}
2.6.2.5.5 Invoicing JSON data
{
    "Vat": "Lorem",
    "InvoiceId": "Lorem"
}
2.7 Group InvestmentManagement
2.7.1 InvestmentManagement Properties
PropertyValue
Group nameInvestmentManagement
Technical name
Activatedtrue
Description
Comments
2.7.2 InvestmentManagement Documents
2.7.2.1 Document Financing
2.7.2.1.1 Financing Tree Diagram
2.7.2.1.2 Financing Properties
PropertyValue
Document nameFinancing
Technical name
Activatedtrue
Id
Description
GroupInvestmentManagement
RESTful API
Additional propertiesfalse
Comments
2.7.2.1.3 Financing Fields
FieldTypeReqKeyDescriptionComments
FinancingIdstringfalse
2.7.2.1.3.1 Field FinancingId
2.7.2.1.3.1.1 FinancingId properties
PropertyValue
Name FinancingId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.7.2.1.4 Financing JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Financing",
    "additionalProperties": false,
    "properties": {
        "FinancingId": {
            "type": "string"
        }
    }
}
2.7.2.1.5 Financing JSON data
{
    "FinancingId": "Lorem"
}
2.7.2.2 Document FondStructure
2.7.2.2.1 FondStructure Tree Diagram
2.7.2.2.2 FondStructure Properties
PropertyValue
Document nameFondStructure
Technical name
Activatedtrue
Id
Description
GroupInvestmentManagement
RESTful API
Additional propertiesfalse
Comments
2.7.2.2.3 FondStructure Fields
FieldTypeReqKeyDescriptionComments
FondStructureIdstringfalse
2.7.2.2.3.1 Field FondStructureId
2.7.2.2.3.1.1 FondStructureId properties
PropertyValue
Name FondStructureId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.7.2.2.4 FondStructure JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "FondStructure",
    "additionalProperties": false,
    "properties": {
        "FondStructureId": {
            "type": "string"
        }
    }
}
2.7.2.2.5 FondStructure JSON data
{
    "FondStructureId": "Lorem"
}
2.8 Group MarketData
2.8.1 MarketData Properties
PropertyValue
Group nameMarketData
Technical name
Activatedtrue
Description
Comments
2.8.2 MarketData Documents
2.8.2.1 Document DemandData
2.8.2.1.1 DemandData Tree Diagram
2.8.2.1.2 DemandData Properties
PropertyValue
Document nameDemandData
Technical name
Activatedtrue
Id
Description
GroupMarketData
RESTful API
Additional propertiesfalse
Comments
2.8.2.1.3 DemandData Fields
FieldTypeReqKeyDescriptionComments
DemandDataIdstringfalse
2.8.2.1.3.1 Field DemandDataId
2.8.2.1.3.1.1 DemandDataId properties
PropertyValue
Name DemandDataId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.8.2.1.4 DemandData JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "DemandData",
    "additionalProperties": false,
    "properties": {
        "DemandDataId": {
            "type": "string"
        }
    }
}
2.8.2.1.5 DemandData JSON data
{
    "DemandDataId": "Lorem"
}
2.8.2.2 Document DemographicData
2.8.2.2.1 DemographicData Tree Diagram
2.8.2.2.2 DemographicData Properties
PropertyValue
Document nameDemographicData
Technical name
Activatedtrue
Id
Description
GroupMarketData
RESTful API
Additional propertiesfalse
Comments
2.8.2.2.3 DemographicData Fields
FieldTypeReqKeyDescriptionComments
DemographicDataIdstringfalse
2.8.2.2.3.1 Field DemographicDataId
2.8.2.2.3.1.1 DemographicDataId properties
PropertyValue
Name DemographicDataId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.8.2.2.4 DemographicData JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "DemographicData",
    "additionalProperties": false,
    "properties": {
        "DemographicDataId": {
            "type": "string"
        }
    }
}
2.8.2.2.5 DemographicData JSON data
{
    "DemographicDataId": "Lorem"
}
2.8.2.3 Document LocationInformation
2.8.2.3.1 LocationInformation Tree Diagram
2.8.2.3.2 LocationInformation Properties
PropertyValue
Document nameLocationInformation
Technical name
Activatedtrue
Id
Description
GroupMarketData
RESTful API
Additional propertiesfalse
Comments
2.8.2.3.3 LocationInformation Fields
FieldTypeReqKeyDescriptionComments
InformationIdstringfalse
2.8.2.3.3.1 Field InformationId
2.8.2.3.3.1.1 InformationId properties
PropertyValue
Name InformationId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.8.2.3.4 LocationInformation JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "LocationInformation",
    "additionalProperties": false,
    "properties": {
        "InformationId": {
            "type": "string"
        }
    }
}
2.8.2.3.5 LocationInformation JSON data
{
    "InformationId": "Lorem"
}
2.8.2.4 Document MobilityData
2.8.2.4.1 MobilityData Tree Diagram
2.8.2.4.2 MobilityData Properties
PropertyValue
Document nameMobilityData
Technical name
Activatedtrue
Id
Description
GroupMarketData
RESTful API
Additional propertiesfalse
Comments
2.8.2.4.3 MobilityData Fields
FieldTypeReqKeyDescriptionComments
MobilityDataIdstringfalse
2.8.2.4.3.1 Field MobilityDataId
2.8.2.4.3.1.1 MobilityDataId properties
PropertyValue
Name MobilityDataId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.8.2.4.4 MobilityData JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "MobilityData",
    "additionalProperties": false,
    "properties": {
        "MobilityDataId": {
            "type": "string"
        }
    }
}
2.8.2.4.5 MobilityData JSON data
{
    "MobilityDataId": "Lorem"
}
2.8.2.5 Document RentalData
2.8.2.5.1 RentalData Tree Diagram
2.8.2.5.2 RentalData Properties
PropertyValue
Document nameRentalData
Technical name
Activatedtrue
Id
Description
GroupMarketData
RESTful API
Additional propertiesfalse
Comments
2.8.2.5.3 RentalData Fields
FieldTypeReqKeyDescriptionComments
RentalDataIdstringfalse
2.8.2.5.3.1 Field RentalDataId
2.8.2.5.3.1.1 RentalDataId properties
PropertyValue
Name RentalDataId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.8.2.5.4 RentalData JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "RentalData",
    "additionalProperties": false,
    "properties": {
        "RentalDataId": {
            "type": "string"
        }
    }
}
2.8.2.5.5 RentalData JSON data
{
    "RentalDataId": "Lorem"
}
2.9 Group Order Management
2.9.1 Order Management Properties
PropertyValue
Group nameOrder Management
Technical name
Activatedtrue
Description
Comments
2.9.2 Order Management Documents
2.9.2.1 Document FrameworkContract
2.9.2.1.1 FrameworkContract Tree Diagram
2.9.2.1.2 FrameworkContract Properties
PropertyValue
Document nameFrameworkContract
Technical name
Activatedtrue
Id
Description
GroupOrder Management
RESTful API
Additional propertiesfalse
Comments
2.9.2.1.3 FrameworkContract Fields
FieldTypeReqKeyDescriptionComments
ContractIdstringfalse
ContractTpestringfalse
IssuerIdstringfalse
RecipientIdstringfalse
ValidFromstringfalse

[{"dataType":"dateTime"}]

ValidUntilstringfalse

[{"dataType":"dateTime"}]

Termsstringfalse
Valuenumberfalse
Currencystringfalse
DocumentIdstringfalse
SiteIdstringfalse
BuildingIdstringfalse
FloorIdstringfalse
SpaceIdstringfalse
2.9.2.1.3.1 Field ContractId
2.9.2.1.3.1.1 ContractId properties
PropertyValue
Name ContractId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.1.3.2 Field ContractTpe
2.9.2.1.3.2.1 ContractTpe properties
PropertyValue
Name ContractTpe
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.1.3.3 Field IssuerId
2.9.2.1.3.3.1 IssuerId properties
PropertyValue
Name IssuerId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.1.3.4 Field RecipientId
2.9.2.1.3.4.1 RecipientId properties
PropertyValue
Name RecipientId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.1.3.5 Field ValidFrom
2.9.2.1.3.5.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.9.2.1.3.6 Field ValidUntil
2.9.2.1.3.6.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.9.2.1.3.7 Field Terms
2.9.2.1.3.7.1 Terms properties
PropertyValue
Name Terms
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.1.3.8 Field Value
2.9.2.1.3.8.1 Value properties
PropertyValue
Name Value
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.9.2.1.3.9 Field Currency
2.9.2.1.3.9.1 Currency properties
PropertyValue
Name Currency
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.1.3.10 Field DocumentId
2.9.2.1.3.10.1 DocumentId properties
PropertyValue
Name DocumentId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.1.3.11 Field SiteId
2.9.2.1.3.11.1 SiteId properties
PropertyValue
Name SiteId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.1.3.12 Field BuildingId
2.9.2.1.3.12.1 BuildingId properties
PropertyValue
Name BuildingId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.1.3.13 Field FloorId
2.9.2.1.3.13.1 FloorId properties
PropertyValue
Name FloorId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.1.3.14 Field SpaceId
2.9.2.1.3.14.1 SpaceId properties
PropertyValue
Name SpaceId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.1.4 FrameworkContract JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "FrameworkContract",
    "additionalProperties": false,
    "properties": {
        "ContractId": {
            "type": "string"
        },
        "ContractTpe": {
            "type": "string"
        },
        "IssuerId": {
            "type": "string"
        },
        "RecipientId": {
            "type": "string"
        },
        "ValidFrom": {
            "type": "string"
        },
        "ValidUntil": {
            "type": "string"
        },
        "Terms": {
            "type": "string"
        },
        "Value": {
            "type": "number"
        },
        "Currency": {
            "type": "string"
        },
        "DocumentId": {
            "type": "string"
        },
        "SiteId": {
            "type": "string"
        },
        "BuildingId": {
            "type": "string"
        },
        "FloorId": {
            "type": "string"
        },
        "SpaceId": {
            "type": "string"
        }
    }
}
2.9.2.1.5 FrameworkContract JSON data
{
    "ContractId": "Lorem",
    "ContractTpe": "Lorem",
    "IssuerId": "Lorem",
    "RecipientId": "Lorem",
    "ValidFrom": "Lorem",
    "ValidUntil": "Lorem",
    "Terms": "Lorem",
    "Value": 82,
    "Currency": "Lorem",
    "DocumentId": "Lorem",
    "SiteId": "Lorem",
    "BuildingId": "Lorem",
    "FloorId": "Lorem",
    "SpaceId": "Lorem"
}
2.9.2.2 Document GoodIssueServiceConfirmation
2.9.2.2.1 GoodIssueServiceConfirmation Tree Diagram
2.9.2.2.2 GoodIssueServiceConfirmation Properties
PropertyValue
Document nameGoodIssueServiceConfirmation
Technical name
Activatedtrue
Id
Description
GroupOrder Management
RESTful API
Additional propertiesfalse
Comments
2.9.2.2.3 GoodIssueServiceConfirmation Fields
FieldTypeReqKeyDescriptionComments
ConfirmationIdstringfalse
2.9.2.2.3.1 Field ConfirmationId
2.9.2.2.3.1.1 ConfirmationId properties
PropertyValue
Name ConfirmationId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.2.4 GoodIssueServiceConfirmation JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "GoodIssueServiceConfirmation",
    "additionalProperties": false,
    "properties": {
        "ConfirmationId": {
            "type": "string"
        }
    }
}
2.9.2.2.5 GoodIssueServiceConfirmation JSON data
{
    "ConfirmationId": "Lorem"
}
2.9.2.3 Document Insurance
2.9.2.3.1 Insurance Tree Diagram
2.9.2.3.2 Insurance Properties
PropertyValue
Document nameInsurance
Technical name
Activatedtrue
Id
Description
GroupOrder Management
RESTful API
Additional propertiesfalse
Comments
2.9.2.3.3 Insurance Fields
FieldTypeReqKeyDescriptionComments
InsuranceIdstringfalse
2.9.2.3.3.1 Field InsuranceId
2.9.2.3.3.1.1 InsuranceId properties
PropertyValue
Name InsuranceId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.3.4 Insurance JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Insurance",
    "additionalProperties": false,
    "properties": {
        "InsuranceId": {
            "type": "string"
        }
    }
}
2.9.2.3.5 Insurance JSON data
{
    "InsuranceId": "Lorem"
}
2.9.2.4 Document MaintenanceContract
2.9.2.4.1 MaintenanceContract Tree Diagram
2.9.2.4.2 MaintenanceContract Properties
PropertyValue
Document nameMaintenanceContract
Technical name
Activatedtrue
Id
Description
GroupOrder Management
RESTful API
Additional propertiesfalse
Comments
2.9.2.4.3 MaintenanceContract Fields
FieldTypeReqKeyDescriptionComments
ContractIdstringfalse
Typestringfalse
MaintenanceDutystringfalse
CalibrationPeriodstringfalse
DateofApprovalstringfalse

[{ "dataType":"DateTime"}]

CommissioningDatestringfalse
WarrantyPeriodstringfalse
ServiceLifestringfalse
MaintenanceIntervalstringfalse
2.9.2.4.3.1 Field ContractId
2.9.2.4.3.1.1 ContractId properties
PropertyValue
Name ContractId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.4.3.2 Field Type
2.9.2.4.3.2.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.4.3.3 Field MaintenanceDuty
2.9.2.4.3.3.1 MaintenanceDuty properties
PropertyValue
Name MaintenanceDuty
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.4.3.4 Field CalibrationPeriod
2.9.2.4.3.4.1 CalibrationPeriod properties
PropertyValue
Name CalibrationPeriod
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.4.3.5 Field DateofApproval
2.9.2.4.3.5.1 DateofApproval properties
PropertyValue
Name DateofApproval
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{ "dataType":"DateTime"}]

2.9.2.4.3.6 Field CommissioningDate
2.9.2.4.3.6.1 CommissioningDate properties
PropertyValue
Name CommissioningDate
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.4.3.7 Field WarrantyPeriod
2.9.2.4.3.7.1 WarrantyPeriod properties
PropertyValue
Name WarrantyPeriod
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.4.3.8 Field ServiceLife
2.9.2.4.3.8.1 ServiceLife properties
PropertyValue
Name ServiceLife
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.4.3.9 Field MaintenanceInterval
2.9.2.4.3.9.1 MaintenanceInterval properties
PropertyValue
Name MaintenanceInterval
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.4.4 MaintenanceContract JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "MaintenanceContract",
    "additionalProperties": false,
    "properties": {
        "ContractId": {
            "type": "string"
        },
        "Type": {
            "type": "string"
        },
        "MaintenanceDuty": {
            "type": "string"
        },
        "CalibrationPeriod": {
            "type": "string"
        },
        "DateofApproval": {
            "type": "string"
        },
        "CommissioningDate": {
            "type": "string"
        },
        "WarrantyPeriod": {
            "type": "string"
        },
        "ServiceLife": {
            "type": "string"
        },
        "MaintenanceInterval": {
            "type": "string"
        }
    }
}
2.9.2.4.5 MaintenanceContract JSON data
{
    "ContractId": "Lorem",
    "Type": "Lorem",
    "MaintenanceDuty": "Lorem",
    "CalibrationPeriod": "Lorem",
    "DateofApproval": "Lorem",
    "CommissioningDate": "Lorem",
    "WarrantyPeriod": "Lorem",
    "ServiceLife": "Lorem",
    "MaintenanceInterval": "Lorem"
}
2.9.2.5 Document Offer
2.9.2.5.1 Offer Tree Diagram
2.9.2.5.2 Offer Properties
PropertyValue
Document nameOffer
Technical name
Activatedtrue
Id
Description
GroupOrder Management
RESTful API
Additional propertiesfalse
Comments
2.9.2.5.3 Offer Fields
FieldTypeReqKeyDescriptionComments
OfferIdstringfalse
2.9.2.5.3.1 Field OfferId
2.9.2.5.3.1.1 OfferId properties
PropertyValue
Name OfferId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.5.4 Offer JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Offer",
    "additionalProperties": false,
    "properties": {
        "OfferId": {
            "type": "string"
        }
    }
}
2.9.2.5.5 Offer JSON data
{
    "OfferId": "Lorem"
}
2.9.2.6 Document PurchaseOrder
2.9.2.6.1 PurchaseOrder Tree Diagram
2.9.2.6.2 PurchaseOrder Properties
PropertyValue
Document namePurchaseOrder
Technical name
Activatedtrue
Id
Description
GroupOrder Management
RESTful API
Additional propertiesfalse
Comments
2.9.2.6.3 PurchaseOrder Fields
FieldTypeReqKeyDescriptionComments
OrderIdintegerfalse
PurchaseOrderTypestringfalse
2.9.2.6.3.1 Field OrderId
2.9.2.6.3.1.1 OrderId properties
PropertyValue
Name OrderId
Technical name
Activated true
Id
Type integer
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.9.2.6.3.2 Field PurchaseOrderType
2.9.2.6.3.2.1 PurchaseOrderType properties
PropertyValue
Name PurchaseOrderType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.6.4 PurchaseOrder JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "PurchaseOrder",
    "additionalProperties": false,
    "properties": {
        "OrderId": {
            "type": "number"
        },
        "PurchaseOrderType": {
            "type": "string"
        }
    }
}
2.9.2.6.5 PurchaseOrder JSON data
{
    "OrderId": -71,
    "PurchaseOrderType": "Lorem"
}
2.9.2.7 Document PurchaseRequisition
2.9.2.7.1 PurchaseRequisition Tree Diagram
2.9.2.7.2 PurchaseRequisition Properties
PropertyValue
Document namePurchaseRequisition
Technical name
Activatedtrue
Id
Description
GroupOrder Management
RESTful API
Additional propertiesfalse
Comments
2.9.2.7.3 PurchaseRequisition Fields
FieldTypeReqKeyDescriptionComments
PurchaseIdstringfalse
2.9.2.7.3.1 Field PurchaseId
2.9.2.7.3.1.1 PurchaseId properties
PropertyValue
Name PurchaseId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.7.4 PurchaseRequisition JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "PurchaseRequisition",
    "additionalProperties": false,
    "properties": {
        "PurchaseId": {
            "type": "string"
        }
    }
}
2.9.2.7.5 PurchaseRequisition JSON data
{
    "PurchaseId": "Lorem"
}
2.9.2.8 Document Rating
2.9.2.8.1 Rating Tree Diagram
2.9.2.8.2 Rating Properties
PropertyValue
Document nameRating
Technical name
Activatedtrue
Id
Description
GroupOrder Management
RESTful API
Additional propertiesfalse
Comments
2.9.2.8.3 Rating Fields
FieldTypeReqKeyDescriptionComments
RatingIdstringfalse
2.9.2.8.3.1 Field RatingId
2.9.2.8.3.1.1 RatingId properties
PropertyValue
Name RatingId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.8.4 Rating JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Rating",
    "additionalProperties": false,
    "properties": {
        "RatingId": {
            "type": "string"
        }
    }
}
2.9.2.8.5 Rating JSON data
{
    "RatingId": "Lorem"
}
2.9.2.9 Document Refusal
2.9.2.9.1 Refusal Tree Diagram
2.9.2.9.2 Refusal Properties
PropertyValue
Document nameRefusal
Technical name
Activatedtrue
Id
Description
GroupOrder Management
RESTful API
Additional propertiesfalse
Comments
2.9.2.9.3 Refusal Fields
FieldTypeReqKeyDescriptionComments
RefusalIdstringfalse
2.9.2.9.3.1 Field RefusalId
2.9.2.9.3.1.1 RefusalId properties
PropertyValue
Name RefusalId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.9.4 Refusal JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Refusal",
    "additionalProperties": false,
    "properties": {
        "RefusalId": {
            "type": "string"
        }
    }
}
2.9.2.9.5 Refusal JSON data
{
    "RefusalId": "Lorem"
}
2.9.2.10 Document RequestForProposal
2.9.2.10.1 RequestForProposal Tree Diagram
2.9.2.10.2 RequestForProposal Properties
PropertyValue
Document nameRequestForProposal
Technical name
Activatedtrue
Id
Description
GroupOrder Management
RESTful API
Additional propertiesfalse
Comments
2.9.2.10.3 RequestForProposal Fields
FieldTypeReqKeyDescriptionComments
RequestIdstringfalse
2.9.2.10.3.1 Field RequestId
2.9.2.10.3.1.1 RequestId properties
PropertyValue
Name RequestId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.10.4 RequestForProposal JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "RequestForProposal",
    "additionalProperties": false,
    "properties": {
        "RequestId": {
            "type": "string"
        }
    }
}
2.9.2.10.5 RequestForProposal JSON data
{
    "RequestId": "Lorem"
}
2.9.2.11 Document Service
2.9.2.11.1 Service Tree Diagram
2.9.2.11.2 Service Properties
PropertyValue
Document nameService
Technical name
Activatedtrue
Id
Description
GroupOrder Management
RESTful API
Additional propertiesfalse
Comments
2.9.2.11.3 Service Fields
FieldTypeReqKeyDescriptionComments
ServiceIDstringfalse
2.9.2.11.3.1 Field ServiceID
2.9.2.11.3.1.1 ServiceID properties
PropertyValue
Name ServiceID
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.11.4 Service JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Service",
    "additionalProperties": false,
    "properties": {
        "ServiceID": {
            "type": "string"
        }
    }
}
2.9.2.11.5 Service JSON data
{
    "ServiceID": "Lorem"
}
2.9.2.12 Document WorkOrder
2.9.2.12.1 WorkOrder Tree Diagram
2.9.2.12.2 WorkOrder Properties
PropertyValue
Document nameWorkOrder
Technical name
Activatedtrue
Id
Description
GroupOrder Management
RESTful API
Additional propertiesfalse
Comments
2.9.2.12.3 WorkOrder Fields
FieldTypeReqKeyDescriptionComments
WorkOrderIdstringfalse
2.9.2.12.3.1 Field WorkOrderId
2.9.2.12.3.1.1 WorkOrderId properties
PropertyValue
Name WorkOrderId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.12.4 WorkOrder JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "WorkOrder",
    "additionalProperties": false,
    "properties": {
        "WorkOrderId": {
            "type": "string"
        }
    }
}
2.9.2.12.5 WorkOrder JSON data
{
    "WorkOrderId": "Lorem"
}
2.9.2.13 Document WorkOrderConformation
2.9.2.13.1 WorkOrderConformation Tree Diagram
2.9.2.13.2 WorkOrderConformation Properties
PropertyValue
Document nameWorkOrderConformation
Technical name
Activatedtrue
Id
Description
GroupOrder Management
RESTful API
Additional propertiesfalse
Comments
2.9.2.13.3 WorkOrderConformation Fields
FieldTypeReqKeyDescriptionComments
ConformationIdstringfalse
2.9.2.13.3.1 Field ConformationId
2.9.2.13.3.1.1 ConformationId properties
PropertyValue
Name ConformationId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.9.2.13.4 WorkOrderConformation JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "WorkOrderConformation",
    "additionalProperties": false,
    "properties": {
        "ConformationId": {
            "type": "string"
        }
    }
}
2.9.2.13.5 WorkOrderConformation JSON data
{
    "ConformationId": "Lorem"
}
2.10 Group Organizational Management
2.10.1 Organizational Management Properties
PropertyValue
Group nameOrganizational Management
Technical name
Activatedtrue
Description
Comments
2.10.2 Organizational Management Documents
2.10.2.1 Document Address1
2.10.2.1.1 Address1 Tree Diagram
2.10.2.1.2 Address1 Properties
PropertyValue
Document nameAddress1
Technical name
Activatedtrue
Id
Description
GroupOrganizational Management
RESTful API
Additional propertiesfalse
Comments
2.10.2.1.3 Address1 Fields
FieldTypeReqKeyDescriptionComments
AddressIdstringfalse
2.10.2.1.3.1 Field AddressId
2.10.2.1.3.1.1 AddressId properties
PropertyValue
Name AddressId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.10.2.1.4 Address1 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Address1",
    "additionalProperties": false,
    "properties": {
        "AddressId": {
            "type": "string"
        }
    }
}
2.10.2.1.5 Address1 JSON data
{
    "AddressId": "Lorem"
}
2.10.2.2 Document Address2
2.10.2.2.1 Address2 Tree Diagram
2.10.2.2.2 Address2 Properties
PropertyValue
Document nameAddress2
Technical name
Activatedtrue
Id
Description
GroupOrganizational Management
RESTful API
Additional propertiesfalse
Comments
2.10.2.2.3 Address2 Fields
FieldTypeReqKeyDescriptionComments
2.10.2.2.4 Address2 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Address2",
    "additionalProperties": false
}
2.10.2.2.5 Address2 JSON data
{}
2.10.2.3 Document Authorization
2.10.2.3.1 Authorization Tree Diagram
2.10.2.3.2 Authorization Properties
PropertyValue
Document nameAuthorization
Technical name
Activatedtrue
Id
Description
GroupOrganizational Management
RESTful API
Additional propertiesfalse
Comments
2.10.2.3.3 Authorization Fields
FieldTypeReqKeyDescriptionComments
AuthorizationIdstringfalse
2.10.2.3.3.1 Field AuthorizationId
2.10.2.3.3.1.1 AuthorizationId properties
PropertyValue
Name AuthorizationId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.10.2.3.4 Authorization JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Authorization",
    "additionalProperties": false,
    "properties": {
        "AuthorizationId": {
            "type": "string"
        }
    }
}
2.10.2.3.5 Authorization JSON data
{
    "AuthorizationId": "Lorem"
}
2.10.2.4 Document BusinessPartner
2.10.2.4.1 BusinessPartner Tree Diagram
2.10.2.4.2 BusinessPartner Properties
PropertyValue
Document nameBusinessPartner
Technical name
Activatedtrue
Id
Description
GroupOrganizational Management
RESTful API
Additional propertiesfalse
Comments
2.10.2.4.3 BusinessPartner Fields
FieldTypeReqKeyDescriptionComments
BusinessPartnerIdstringfalse
Titlestringfalse
ForeNamestringfalse
Typestringfalse
ZipCodestringfalse
Countrystringfalse
Citystringfalse
HouseNumberstringfalse
Streetstringfalse
Surnamestringfalse
Vatnumberfalse
2.10.2.4.3.1 Field BusinessPartnerId
2.10.2.4.3.1.1 BusinessPartnerId properties
PropertyValue
Name BusinessPartnerId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.10.2.4.3.2 Field Title
2.10.2.4.3.2.1 Title properties
PropertyValue
Name Title
Technical name Ttl
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.10.2.4.3.3 Field ForeName
2.10.2.4.3.3.1 ForeName properties
PropertyValue
Name ForeName
Technical name FrNm
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.10.2.4.3.4 Field Type
2.10.2.4.3.4.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.10.2.4.3.5 Field ZipCode
2.10.2.4.3.5.1 ZipCode properties
PropertyValue
Name ZipCode
Technical name ZpCd
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.10.2.4.3.6 Field Country
2.10.2.4.3.6.1 Country properties
PropertyValue
Name Country
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.10.2.4.3.7 Field City
2.10.2.4.3.7.1 City properties
PropertyValue
Name City
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.10.2.4.3.8 Field HouseNumber
2.10.2.4.3.8.1 HouseNumber properties
PropertyValue
Name HouseNumber
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.10.2.4.3.9 Field Street
2.10.2.4.3.9.1 Street properties
PropertyValue
Name Street
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.10.2.4.3.10 Field Surname
2.10.2.4.3.10.1 Surname properties
PropertyValue
Name Surname
Technical name Srnm
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.10.2.4.3.11 Field Vat
2.10.2.4.3.11.1 Vat properties
PropertyValue
Name Vat
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.10.2.4.4 BusinessPartner JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "BusinessPartner",
    "additionalProperties": false,
    "properties": {
        "BusinessPartnerId": {
            "type": "string"
        },
        "Ttl": {
            "type": "string"
        },
        "FrNm": {
            "type": "string"
        },
        "Type": {
            "type": "string"
        },
        "ZpCd": {
            "type": "string"
        },
        "Country": {
            "type": "string"
        },
        "City": {
            "type": "string"
        },
        "HouseNumber": {
            "type": "string"
        },
        "Street": {
            "type": "string"
        },
        "Srnm": {
            "type": "string"
        },
        "Vat": {
            "type": "number"
        }
    }
}
2.10.2.4.5 BusinessPartner JSON data
{
    "BusinessPartnerId": "Lorem",
    "Ttl": "Lorem",
    "FrNm": "Lorem",
    "Type": "Lorem",
    "ZpCd": "Lorem",
    "Country": "Lorem",
    "City": "Lorem",
    "HouseNumber": "Lorem",
    "Street": "Lorem",
    "Srnm": "Lorem",
    "Vat": 55
}
2.10.2.5 Document CompanyStructureBusinessUnit
2.10.2.5.1 CompanyStructureBusinessUnit Tree Diagram
2.10.2.5.2 CompanyStructureBusinessUnit Properties
PropertyValue
Document nameCompanyStructureBusinessUnit
Technical name
Activatedtrue
Id
Description
GroupOrganizational Management
RESTful API
Additional propertiesfalse
Comments
2.10.2.5.3 CompanyStructureBusinessUnit Fields
FieldTypeReqKeyDescriptionComments
CompanyStructureIdstringfalse
2.10.2.5.3.1 Field CompanyStructureId
2.10.2.5.3.1.1 CompanyStructureId properties
PropertyValue
Name CompanyStructureId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.10.2.5.4 CompanyStructureBusinessUnit JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "CompanyStructureBusinessUnit",
    "additionalProperties": false,
    "properties": {
        "CompanyStructureId": {
            "type": "string"
        }
    }
}
2.10.2.5.5 CompanyStructureBusinessUnit JSON data
{
    "CompanyStructureId": "Lorem"
}
2.10.2.6 Document Role
2.10.2.6.1 Role Tree Diagram
2.10.2.6.2 Role Properties
PropertyValue
Document nameRole
Technical name
Activatedtrue
Id
Description
GroupOrganizational Management
RESTful API
Additional propertiesfalse
Comments
2.10.2.6.3 Role Fields
FieldTypeReqKeyDescriptionComments
RoleIdstringfalse
BuildingIdstringfalse
2.10.2.6.3.1 Field RoleId
2.10.2.6.3.1.1 RoleId properties
PropertyValue
Name RoleId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.10.2.6.3.2 Field BuildingId
2.10.2.6.3.2.1 BuildingId properties
PropertyValue
Name BuildingId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection Building
Foreign field BuildingId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.10.2.6.4 Role JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Role",
    "additionalProperties": false,
    "properties": {
        "RoleId": {
            "type": "string"
        },
        "BuildingId": {
            "type": "string"
        }
    }
}
2.10.2.6.5 Role JSON data
{
    "RoleId": "Lorem",
    "BuildingId": "Lorem"
}
2.11 Group Portfolio & Asset Management
2.11.1 Portfolio & Asset Management Properties
PropertyValue
Group namePortfolio & Asset Management
Technical name
Activatedtrue
Description
Comments
2.11.2 Portfolio & Asset Management Documents
2.11.2.1 Document PartOfPortfolio
2.11.2.1.1 PartOfPortfolio Tree Diagram
2.11.2.1.2 PartOfPortfolio Properties
PropertyValue
Document namePartOfPortfolio
Technical name
Activatedtrue
Id
Description
GroupPortfolio & Asset Management
RESTful API
Additional propertiesfalse
Comments
2.11.2.1.3 PartOfPortfolio Fields
FieldTypeReqKeyDescriptionComments
LineIdstringfalse
2.11.2.1.3.1 Field LineId
2.11.2.1.3.1.1 LineId properties
PropertyValue
Name LineId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.1.4 PartOfPortfolio JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "PartOfPortfolio",
    "additionalProperties": false,
    "properties": {
        "LineId": {
            "type": "string"
        }
    }
}
2.11.2.1.5 PartOfPortfolio JSON data
{
    "LineId": "Lorem"
}
2.11.2.2 Document Portfolio
2.11.2.2.1 Portfolio Tree Diagram
2.11.2.2.2 Portfolio Properties
PropertyValue
Document namePortfolio
Technical name
Activatedtrue
Id
Description
GroupPortfolio & Asset Management
RESTful API
Additional propertiesfalse
Comments
2.11.2.2.3 Portfolio Fields
FieldTypeReqKeyDescriptionComments
PortfolioIdstringfalse
PortfolioCodestringfalse
Namestringtrue
Typestringfalse
ValidFromstringtrue

[{"dataType":"dateTime"}]

ValidUntilstringfalse

[{"dataType":"dateTime"}]

GrossAreanumberfalse

[{"dataType":"float"}]

BusinessPartnerIdstringfalse
Guidstringfalse
2.11.2.2.3.1 Field PortfolioId
2.11.2.2.3.1.1 PortfolioId properties
PropertyValue
Name PortfolioId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.2.3.2 Field PortfolioCode
2.11.2.2.3.2.1 PortfolioCode properties
PropertyValue
Name PortfolioCode
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.2.3.3 Field Name
2.11.2.2.3.3.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.2.3.4 Field Type
2.11.2.2.3.4.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.2.3.5 Field ValidFrom
2.11.2.2.3.5.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name
Activated true
Id
Type string
Description
Dependencies
Required true
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.11.2.2.3.6 Field ValidUntil
2.11.2.2.3.6.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.11.2.2.3.7 Field GrossArea
2.11.2.2.3.7.1 GrossArea properties
PropertyValue
Name GrossArea
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments

[{"dataType":"float"}]

2.11.2.2.3.8 Field BusinessPartnerId
2.11.2.2.3.8.1 BusinessPartnerId properties
PropertyValue
Name BusinessPartnerId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection BusinessPartner
Foreign field BusinessPartnerId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.2.3.9 Field Guid
2.11.2.2.3.9.1 Guid properties
PropertyValue
Name Guid
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.2.4 Portfolio JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Portfolio",
    "additionalProperties": false,
    "properties": {
        "PortfolioId": {
            "type": "string"
        },
        "PortfolioCode": {
            "type": "string"
        },
        "Name": {
            "type": "string"
        },
        "Type": {
            "type": "string"
        },
        "ValidFrom": {
            "type": "string"
        },
        "ValidUntil": {
            "type": "string"
        },
        "GrossArea": {
            "type": "number"
        },
        "BusinessPartnerId": {
            "type": "string"
        },
        "Guid": {
            "type": "string"
        }
    },
    "required": [
        "Name",
        "ValidFrom"
    ]
}
2.11.2.2.5 Portfolio JSON data
{
    "PortfolioId": "Lorem",
    "PortfolioCode": "Lorem",
    "Name": "Lorem",
    "Type": "Lorem",
    "ValidFrom": "Lorem",
    "ValidUntil": "Lorem",
    "GrossArea": 67,
    "BusinessPartnerId": "Lorem",
    "Guid": "Lorem"
}
2.11.2.3 Document StrategicProgramsandMeasures
2.11.2.3.1 StrategicProgramsandMeasures Tree Diagram
2.11.2.3.2 StrategicProgramsandMeasures Properties
PropertyValue
Document nameStrategicProgramsandMeasures
Technical name
Activatedtrue
Id
Description
GroupPortfolio & Asset Management
RESTful API
Additional propertiesfalse
Comments
2.11.2.3.3 StrategicProgramsandMeasures Fields
FieldTypeReqKeyDescriptionComments
LineIdstringfalse
2.11.2.3.3.1 Field LineId
2.11.2.3.3.1.1 LineId properties
PropertyValue
Name LineId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.3.4 StrategicProgramsandMeasures JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "StrategicProgramsandMeasures",
    "additionalProperties": false,
    "properties": {
        "LineId": {
            "type": "string"
        }
    }
}
2.11.2.3.5 StrategicProgramsandMeasures JSON data
{
    "LineId": "Lorem"
}
2.11.2.4 Document Valuation
2.11.2.4.1 Valuation Tree Diagram
2.11.2.4.2 Valuation Properties
PropertyValue
Document nameValuation
Technical name
Activatedtrue
Id
Description
GroupPortfolio & Asset Management
RESTful API
Additional properties
Comments
2.11.2.4.3 Valuation Fields
FieldTypeReqKeyDescriptionComments
ValuationIdstringfalse
Namestringfalse
Statusstringfalse
ValidFromstringfalse

[{"dataType":"dateTime"}]

ValidUntilstringfalse

[{"dataType":"dateTime"}]

Anystringfalse
Descriptionstringfalse
Textstringfalse
Keywordsstringfalse
URLstringfalse
ValuationTypestringfalse
Jurisdictionstringfalse
LandIdstringfalse
BuildingIdstringfalse
DocumentIdstringfalse
RoleIdstringfalse
TransactionIdstringfalse
ValueIdstringfalse
IncomeIdstringfalse
CostGroupIdstringfalse
CentroIdstringfalse
CertificateIdstringfalse
Building.PrimaryUsestringfalse
Building.SecondaryUsestringfalse
Building.Purposestringfalse
Land.ParcelIdstringfalse
Land.PartOfParcelIdstringfalse
Building.Addressstringfalse
Role.Ownerstringfalse
Role.Tenantstringfalse
Role.Otherstringfalse
PreviousValuationIdstringfalse
PreviousTransaction.Capitalstringfalse
PreviousTransaction.Rentstringfalse
ProfessionalStandardstringfalse
AccountingStandardstringfalse
JurisdictionalStandardstringfalse
ExtendOfInvestigationstringfalse
LimitationsRestrictionsstringfalse
ReportDatestringfalse
ReportDateRangestringfalse
ValuationDatestringfalse
ValuationDateRangestringfalse
PremiseOfValuestringfalse
BasisOfValuestringfalse
NonIVSBasisValuestringfalse
Assumptionsstringfalse
SpecialAssumptionsstringfalse
Constrainsstringfalse
Value.Capitalstringfalse
Value.Rentalstringfalse
Cost.Acquisitionstringfalse
Income.Rentstringfalse
Income.Incomestringfalse
Explainationstringfalse
Approachstringfalse
BuildingId.ComparableEvidencestringfalse
Statisticsstringfalse
2.11.2.4.3.1 Field ValuationId
2.11.2.4.3.1.1 ValuationId properties
PropertyValue
Name ValuationId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.2 Field Name
2.11.2.4.3.2.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.3 Field Status
2.11.2.4.3.3.1 Status properties
PropertyValue
Name Status
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.4 Field ValidFrom
2.11.2.4.3.4.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.11.2.4.3.5 Field ValidUntil
2.11.2.4.3.5.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.11.2.4.3.6 Field Any
2.11.2.4.3.6.1 Any properties
PropertyValue
Name Any
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.7 Field Description
2.11.2.4.3.7.1 Description properties
PropertyValue
Name Description
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.8 Field Text
2.11.2.4.3.8.1 Text properties
PropertyValue
Name Text
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.9 Field Keywords
2.11.2.4.3.9.1 Keywords properties
PropertyValue
Name Keywords
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.10 Field URL
2.11.2.4.3.10.1 URL properties
PropertyValue
Name URL
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.11 Field ValuationType
2.11.2.4.3.11.1 ValuationType properties
PropertyValue
Name ValuationType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.12 Field Jurisdiction
2.11.2.4.3.12.1 Jurisdiction properties
PropertyValue
Name Jurisdiction
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.13 Field LandId
2.11.2.4.3.13.1 LandId properties
PropertyValue
Name LandId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.14 Field BuildingId
2.11.2.4.3.14.1 BuildingId properties
PropertyValue
Name BuildingId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.15 Field DocumentId
2.11.2.4.3.15.1 DocumentId properties
PropertyValue
Name DocumentId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.16 Field RoleId
2.11.2.4.3.16.1 RoleId properties
PropertyValue
Name RoleId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.17 Field TransactionId
2.11.2.4.3.17.1 TransactionId properties
PropertyValue
Name TransactionId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.18 Field ValueId
2.11.2.4.3.18.1 ValueId properties
PropertyValue
Name ValueId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.19 Field IncomeId
2.11.2.4.3.19.1 IncomeId properties
PropertyValue
Name IncomeId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.20 Field CostGroupId
2.11.2.4.3.20.1 CostGroupId properties
PropertyValue
Name CostGroupId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.21 Field CentroId
2.11.2.4.3.21.1 CentroId properties
PropertyValue
Name CentroId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.22 Field CertificateId
2.11.2.4.3.22.1 CertificateId properties
PropertyValue
Name CertificateId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.23 Field Building.PrimaryUse
2.11.2.4.3.23.1 Building.PrimaryUse properties
PropertyValue
Name Building.PrimaryUse
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.24 Field Building.SecondaryUse
2.11.2.4.3.24.1 Building.SecondaryUse properties
PropertyValue
Name Building.SecondaryUse
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.25 Field Building.Purpose
2.11.2.4.3.25.1 Building.Purpose properties
PropertyValue
Name Building.Purpose
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.26 Field Land.ParcelId
2.11.2.4.3.26.1 Land.ParcelId properties
PropertyValue
Name Land.ParcelId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.27 Field Land.PartOfParcelId
2.11.2.4.3.27.1 Land.PartOfParcelId properties
PropertyValue
Name Land.PartOfParcelId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.28 Field Building.Address
2.11.2.4.3.28.1 Building.Address properties
PropertyValue
Name Building.Address
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.29 Field Role.Owner
2.11.2.4.3.29.1 Role.Owner properties
PropertyValue
Name Role.Owner
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.30 Field Role.Tenant
2.11.2.4.3.30.1 Role.Tenant properties
PropertyValue
Name Role.Tenant
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.31 Field Role.Other
2.11.2.4.3.31.1 Role.Other properties
PropertyValue
Name Role.Other
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.32 Field PreviousValuationId
2.11.2.4.3.32.1 PreviousValuationId properties
PropertyValue
Name PreviousValuationId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.33 Field PreviousTransaction.Capital
2.11.2.4.3.33.1 PreviousTransaction.Capital properties
PropertyValue
Name PreviousTransaction.Capital
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.34 Field PreviousTransaction.Rent
2.11.2.4.3.34.1 PreviousTransaction.Rent properties
PropertyValue
Name PreviousTransaction.Rent
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.35 Field ProfessionalStandard
2.11.2.4.3.35.1 ProfessionalStandard properties
PropertyValue
Name ProfessionalStandard
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.36 Field AccountingStandard
2.11.2.4.3.36.1 AccountingStandard properties
PropertyValue
Name AccountingStandard
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.37 Field JurisdictionalStandard
2.11.2.4.3.37.1 JurisdictionalStandard properties
PropertyValue
Name JurisdictionalStandard
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.38 Field ExtendOfInvestigation
2.11.2.4.3.38.1 ExtendOfInvestigation properties
PropertyValue
Name ExtendOfInvestigation
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.39 Field LimitationsRestrictions
2.11.2.4.3.39.1 LimitationsRestrictions properties
PropertyValue
Name LimitationsRestrictions
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.40 Field ReportDate
2.11.2.4.3.40.1 ReportDate properties
PropertyValue
Name ReportDate
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.41 Field ReportDateRange
2.11.2.4.3.41.1 ReportDateRange properties
PropertyValue
Name ReportDateRange
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.42 Field ValuationDate
2.11.2.4.3.42.1 ValuationDate properties
PropertyValue
Name ValuationDate
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.43 Field ValuationDateRange
2.11.2.4.3.43.1 ValuationDateRange properties
PropertyValue
Name ValuationDateRange
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.44 Field PremiseOfValue
2.11.2.4.3.44.1 PremiseOfValue properties
PropertyValue
Name PremiseOfValue
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.45 Field BasisOfValue
2.11.2.4.3.45.1 BasisOfValue properties
PropertyValue
Name BasisOfValue
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.46 Field NonIVSBasisValue
2.11.2.4.3.46.1 NonIVSBasisValue properties
PropertyValue
Name NonIVSBasisValue
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.47 Field Assumptions
2.11.2.4.3.47.1 Assumptions properties
PropertyValue
Name Assumptions
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.48 Field SpecialAssumptions
2.11.2.4.3.48.1 SpecialAssumptions properties
PropertyValue
Name SpecialAssumptions
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.49 Field Constrains
2.11.2.4.3.49.1 Constrains properties
PropertyValue
Name Constrains
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.50 Field Value.Capital
2.11.2.4.3.50.1 Value.Capital properties
PropertyValue
Name Value.Capital
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.51 Field Value.Rental
2.11.2.4.3.51.1 Value.Rental properties
PropertyValue
Name Value.Rental
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.52 Field Cost.Acquisition
2.11.2.4.3.52.1 Cost.Acquisition properties
PropertyValue
Name Cost.Acquisition
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.53 Field Income.Rent
2.11.2.4.3.53.1 Income.Rent properties
PropertyValue
Name Income.Rent
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.54 Field Income.Income
2.11.2.4.3.54.1 Income.Income properties
PropertyValue
Name Income.Income
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.55 Field Explaination
2.11.2.4.3.55.1 Explaination properties
PropertyValue
Name Explaination
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.56 Field Approach
2.11.2.4.3.56.1 Approach properties
PropertyValue
Name Approach
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.57 Field BuildingId.ComparableEvidence
2.11.2.4.3.57.1 BuildingId.ComparableEvidence properties
PropertyValue
Name BuildingId.ComparableEvidence
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.3.58 Field Statistics
2.11.2.4.3.58.1 Statistics properties
PropertyValue
Name Statistics
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.11.2.4.4 Valuation JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Valuation",
    "properties": {
        "ValuationId": {
            "type": "string"
        },
        "Name": {
            "type": "string"
        },
        "Status": {
            "type": "string"
        },
        "ValidFrom": {
            "type": "string"
        },
        "ValidUntil": {
            "type": "string"
        },
        "Any": {
            "type": "string"
        },
        "Description": {
            "type": "string"
        },
        "Text": {
            "type": "string"
        },
        "Keywords": {
            "type": "string"
        },
        "URL": {
            "type": "string"
        },
        "ValuationType": {
            "type": "string"
        },
        "Jurisdiction": {
            "type": "string"
        },
        "LandId": {
            "type": "string"
        },
        "BuildingId": {
            "type": "string"
        },
        "DocumentId": {
            "type": "string"
        },
        "RoleId": {
            "type": "string"
        },
        "TransactionId": {
            "type": "string"
        },
        "ValueId": {
            "type": "string"
        },
        "IncomeId": {
            "type": "string"
        },
        "CostGroupId": {
            "type": "string"
        },
        "CentroId": {
            "type": "string"
        },
        "CertificateId": {
            "type": "string"
        },
        "Building.PrimaryUse": {
            "type": "string"
        },
        "Building.SecondaryUse": {
            "type": "string"
        },
        "Building.Purpose": {
            "type": "string"
        },
        "Land.ParcelId": {
            "type": "string"
        },
        "Land.PartOfParcelId": {
            "type": "string"
        },
        "Building.Address": {
            "type": "string"
        },
        "Role.Owner": {
            "type": "string"
        },
        "Role.Tenant": {
            "type": "string"
        },
        "Role.Other": {
            "type": "string"
        },
        "PreviousValuationId": {
            "type": "string"
        },
        "PreviousTransaction.Capital": {
            "type": "string"
        },
        "PreviousTransaction.Rent": {
            "type": "string"
        },
        "ProfessionalStandard": {
            "type": "string"
        },
        "AccountingStandard": {
            "type": "string"
        },
        "JurisdictionalStandard": {
            "type": "string"
        },
        "ExtendOfInvestigation": {
            "type": "string"
        },
        "LimitationsRestrictions": {
            "type": "string"
        },
        "ReportDate": {
            "type": "string"
        },
        "ReportDateRange": {
            "type": "string"
        },
        "ValuationDate": {
            "type": "string"
        },
        "ValuationDateRange": {
            "type": "string"
        },
        "PremiseOfValue": {
            "type": "string"
        },
        "BasisOfValue": {
            "type": "string"
        },
        "NonIVSBasisValue": {
            "type": "string"
        },
        "Assumptions": {
            "type": "string"
        },
        "SpecialAssumptions": {
            "type": "string"
        },
        "Constrains": {
            "type": "string"
        },
        "Value.Capital": {
            "type": "string"
        },
        "Value.Rental": {
            "type": "string"
        },
        "Cost.Acquisition": {
            "type": "string"
        },
        "Income.Rent": {
            "type": "string"
        },
        "Income.Income": {
            "type": "string"
        },
        "Explaination": {
            "type": "string"
        },
        "Approach": {
            "type": "string"
        },
        "BuildingId.ComparableEvidence": {
            "type": "string"
        },
        "Statistics": {
            "type": "string"
        }
    }
}
2.11.2.4.5 Valuation JSON data
{
    "ValuationId": "Lorem",
    "Name": "Lorem",
    "Status": "Lorem",
    "ValidFrom": "Lorem",
    "ValidUntil": "Lorem",
    "Any": "Lorem",
    "Description": "Lorem",
    "Text": "Lorem",
    "Keywords": "Lorem",
    "URL": "Lorem",
    "ValuationType": "Lorem",
    "Jurisdiction": "Lorem",
    "LandId": "Lorem",
    "BuildingId": "Lorem",
    "DocumentId": "Lorem",
    "RoleId": "Lorem",
    "TransactionId": "Lorem",
    "ValueId": "Lorem",
    "IncomeId": "Lorem",
    "CostGroupId": "Lorem",
    "CentroId": "Lorem",
    "CertificateId": "Lorem",
    "Building.PrimaryUse": "Lorem",
    "Building.SecondaryUse": "Lorem",
    "Building.Purpose": "Lorem",
    "Land.ParcelId": "Lorem",
    "Land.PartOfParcelId": "Lorem",
    "Building.Address": "Lorem",
    "Role.Owner": "Lorem",
    "Role.Tenant": "Lorem",
    "Role.Other": "Lorem",
    "PreviousValuationId": "Lorem",
    "PreviousTransaction.Capital": "Lorem",
    "PreviousTransaction.Rent": "Lorem",
    "ProfessionalStandard": "Lorem",
    "AccountingStandard": "Lorem",
    "JurisdictionalStandard": "Lorem",
    "ExtendOfInvestigation": "Lorem",
    "LimitationsRestrictions": "Lorem",
    "ReportDate": "Lorem",
    "ReportDateRange": "Lorem",
    "ValuationDate": "Lorem",
    "ValuationDateRange": "Lorem",
    "PremiseOfValue": "Lorem",
    "BasisOfValue": "Lorem",
    "NonIVSBasisValue": "Lorem",
    "Assumptions": "Lorem",
    "SpecialAssumptions": "Lorem",
    "Constrains": "Lorem",
    "Value.Capital": "Lorem",
    "Value.Rental": "Lorem",
    "Cost.Acquisition": "Lorem",
    "Income.Rent": "Lorem",
    "Income.Income": "Lorem",
    "Explaination": "Lorem",
    "Approach": "Lorem",
    "BuildingId.ComparableEvidence": "Lorem",
    "Statistics": "Lorem"
}
2.12 Group Project Management
2.12.1 Project Management Properties
PropertyValue
Group nameProject Management
Technical name
Activatedtrue
Description
Comments
2.12.2 Project Management Documents
2.12.2.1 Document Activity
2.12.2.1.1 Activity Tree Diagram
2.12.2.1.2 Activity Properties
PropertyValue
Document nameActivity
Technical name
Activatedtrue
Id
Description
GroupProject Management
RESTful API
Additional propertiesfalse
Comments
2.12.2.1.3 Activity Fields
FieldTypeReqKeyDescriptionComments
ActivityIdstringfalse
2.12.2.1.3.1 Field ActivityId
2.12.2.1.3.1.1 ActivityId properties
PropertyValue
Name ActivityId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.12.2.1.4 Activity JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Activity",
    "additionalProperties": false,
    "properties": {
        "ActivityId": {
            "type": "string"
        }
    }
}
2.12.2.1.5 Activity JSON data
{
    "ActivityId": "Lorem"
}
2.12.2.2 Document CompletionExcecution
2.12.2.2.1 CompletionExcecution Tree Diagram
2.12.2.2.2 CompletionExcecution Properties
PropertyValue
Document nameCompletionExcecution
Technical name
Activatedtrue
Id
Description
GroupProject Management
RESTful API
Additional propertiesfalse
Comments
2.12.2.2.3 CompletionExcecution Fields
FieldTypeReqKeyDescriptionComments
ExecutionIdstringfalse
2.12.2.2.3.1 Field ExecutionId
2.12.2.2.3.1.1 ExecutionId properties
PropertyValue
Name ExecutionId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.12.2.2.4 CompletionExcecution JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "CompletionExcecution",
    "additionalProperties": false,
    "properties": {
        "ExecutionId": {
            "type": "string"
        }
    }
}
2.12.2.2.5 CompletionExcecution JSON data
{
    "ExecutionId": "Lorem"
}
2.12.2.3 Document Milestones
2.12.2.3.1 Milestones Tree Diagram
2.12.2.3.2 Milestones Properties
PropertyValue
Document nameMilestones
Technical name
Activatedtrue
Id
Description
GroupProject Management
RESTful API
Additional propertiesfalse
Comments
2.12.2.3.3 Milestones Fields
FieldTypeReqKeyDescriptionComments
MilestonesIdstringfalse
2.12.2.3.3.1 Field MilestonesId
2.12.2.3.3.1.1 MilestonesId properties
PropertyValue
Name MilestonesId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.12.2.3.4 Milestones JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Milestones",
    "additionalProperties": false,
    "properties": {
        "MilestonesId": {
            "type": "string"
        }
    }
}
2.12.2.3.5 Milestones JSON data
{
    "MilestonesId": "Lorem"
}
2.12.2.4 Document Project
2.12.2.4.1 Project Tree Diagram
2.12.2.4.2 Project Properties
PropertyValue
Document nameProject
Technical name
Activatedtrue
Id
Description
GroupProject Management
RESTful API
Additional propertiesfalse
Comments
2.12.2.4.3 Project Fields
FieldTypeReqKeyDescriptionComments
ProjectIdstringfalse
2.12.2.4.3.1 Field ProjectId
2.12.2.4.3.1.1 ProjectId properties
PropertyValue
Name ProjectId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.12.2.4.4 Project JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Project",
    "additionalProperties": false,
    "properties": {
        "ProjectId": {
            "type": "string"
        }
    }
}
2.12.2.4.5 Project JSON data
{
    "ProjectId": "Lorem"
}
2.12.2.5 Document ProjectDates
2.12.2.5.1 ProjectDates Tree Diagram
2.12.2.5.2 ProjectDates Properties
PropertyValue
Document nameProjectDates
Technical name
Activatedtrue
Id
Description
GroupProject Management
RESTful API
Additional propertiesfalse
Comments
2.12.2.5.3 ProjectDates Fields
FieldTypeReqKeyDescriptionComments
ProjectDatesIdstringfalse
2.12.2.5.3.1 Field ProjectDatesId
2.12.2.5.3.1.1 ProjectDatesId properties
PropertyValue
Name ProjectDatesId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.12.2.5.4 ProjectDates JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "ProjectDates",
    "additionalProperties": false,
    "properties": {
        "ProjectDatesId": {
            "type": "string"
        }
    }
}
2.12.2.5.5 ProjectDates JSON data
{
    "ProjectDatesId": "Lorem"
}
2.12.2.6 Document ProjectWorkBreakDownStructure
2.12.2.6.1 ProjectWorkBreakDownStructure Tree Diagram
2.12.2.6.2 ProjectWorkBreakDownStructure Properties
PropertyValue
Document nameProjectWorkBreakDownStructure
Technical name
Activatedtrue
Id
Description
GroupProject Management
RESTful API
Additional propertiesfalse
Comments
2.12.2.6.3 ProjectWorkBreakDownStructure Fields
FieldTypeReqKeyDescriptionComments
BreakDownIdstringfalse
2.12.2.6.3.1 Field BreakDownId
2.12.2.6.3.1.1 BreakDownId properties
PropertyValue
Name BreakDownId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.12.2.6.4 ProjectWorkBreakDownStructure JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "ProjectWorkBreakDownStructure",
    "additionalProperties": false,
    "properties": {
        "BreakDownId": {
            "type": "string"
        }
    }
}
2.12.2.6.5 ProjectWorkBreakDownStructure JSON data
{
    "BreakDownId": "Lorem"
}
2.12.2.7 Document Risk
2.12.2.7.1 Risk Tree Diagram
2.12.2.7.2 Risk Properties
PropertyValue
Document nameRisk
Technical name
Activatedtrue
Id
Description
GroupProject Management
RESTful API
Additional propertiesfalse
Comments
2.12.2.7.3 Risk Fields
FieldTypeReqKeyDescriptionComments
RiskIdstringfalse
2.12.2.7.3.1 Field RiskId
2.12.2.7.3.1.1 RiskId properties
PropertyValue
Name RiskId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.12.2.7.4 Risk JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Risk",
    "additionalProperties": false,
    "properties": {
        "RiskId": {
            "type": "string"
        }
    }
}
2.12.2.7.5 Risk JSON data
{
    "RiskId": "Lorem"
}
2.13 Group Property Management
2.13.1 Property Management Properties
PropertyValue
Group nameProperty Management
Technical name
Activatedtrue
Description
Comments
2.13.2 Property Management Documents
2.13.2.1 Document Dunning
2.13.2.1.1 Dunning Tree Diagram
2.13.2.1.2 Dunning Properties
PropertyValue
Document nameDunning
Technical name
Activatedtrue
Id
Description
GroupProperty Management
RESTful API
Additional propertiesfalse
Comments
2.13.2.1.3 Dunning Fields
FieldTypeReqKeyDescriptionComments
DunningIdstringfalse
2.13.2.1.3.1 Field DunningId
2.13.2.1.3.1.1 DunningId properties
PropertyValue
Name DunningId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.1.4 Dunning JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Dunning",
    "additionalProperties": false,
    "properties": {
        "DunningId": {
            "type": "string"
        }
    }
}
2.13.2.1.5 Dunning JSON data
{
    "DunningId": "Lorem"
}
2.13.2.2 Document LeaseContract
2.13.2.2.1 LeaseContract Tree Diagram
2.13.2.2.2 LeaseContract Properties
PropertyValue
Document nameLeaseContract
Technical name
Activatedtrue
Id
Description
GroupProperty Management
RESTful API
Additional propertiesfalse
Comments
2.13.2.2.3 LeaseContract Fields
FieldTypeReqKeyDescriptionComments
CompanyCodestringfalse
Regionstringfalse
ContractCodestringfalse
Namestringfalse
ContractGroupstringfalse
Lesseestringfalse
Lessorstringfalse
ContractStatusstringfalse
ContractStartDatestringfalse
ContractEndDatestringfalse
ContractPeriodstringfalse
RentalUnitstringfalse
Spacestringfalse
Floorstringfalse
Buildingstringfalse
AddressLine1stringfalse
PostalCodestringfalse
Citystringfalse
Countrystringfalse
ContractDescriptionstringfalse
DateEffectiveContractLinestringfalse
EndDateContractLinestringfalse
StartDateModificationstringfalse
AmountPerstringfalse

Weekly Monthly Quarterly HalfYearly Yearly

Amountnumberfalse
EndDateModificationstringfalse
ContractCurrencystringfalse
BaseC urrencystringfalse
FxRatestringfalse
YearlyTotalstringfalse
ReportingCurrencystringfalse
ContractLinePeriodstringfalse
CostGroupnumberfalse
ProfitCenternumberfalse
BusinessAreanumberfalse
CostCategorynumberfalse
FinancialReportingEntitystringfalse
PaymentInAdvancestringfalse
PaymentFrequencystringfalse
DateofFirstPAymentstringfalse
ShortTermLeasestringfalse
AccountingStandardstringfalse
ContractTypestringfalse
DiscountRatestringfalse
2.13.2.2.3.1 Field CompanyCode
2.13.2.2.3.1.1 CompanyCode properties
PropertyValue
Name CompanyCode
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.2 Field Region
2.13.2.2.3.2.1 Region properties
PropertyValue
Name Region
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.3 Field ContractCode
2.13.2.2.3.3.1 ContractCode properties
PropertyValue
Name ContractCode
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.4 Field Name
2.13.2.2.3.4.1 Name properties
PropertyValue
Name Name
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.5 Field ContractGroup
2.13.2.2.3.5.1 ContractGroup properties
PropertyValue
Name ContractGroup
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.6 Field Lessee
2.13.2.2.3.6.1 Lessee properties
PropertyValue
Name Lessee
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.7 Field Lessor
2.13.2.2.3.7.1 Lessor properties
PropertyValue
Name Lessor
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.8 Field ContractStatus
2.13.2.2.3.8.1 ContractStatus properties
PropertyValue
Name ContractStatus
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.9 Field ContractStartDate
2.13.2.2.3.9.1 ContractStartDate properties
PropertyValue
Name ContractStartDate
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.10 Field ContractEndDate
2.13.2.2.3.10.1 ContractEndDate properties
PropertyValue
Name ContractEndDate
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.11 Field ContractPeriod
2.13.2.2.3.11.1 ContractPeriod properties
PropertyValue
Name ContractPeriod
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.12 Field RentalUnit
2.13.2.2.3.12.1 RentalUnit properties
PropertyValue
Name RentalUnit
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.13 Field Space
2.13.2.2.3.13.1 Space properties
PropertyValue
Name Space
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.14 Field Floor
2.13.2.2.3.14.1 Floor properties
PropertyValue
Name Floor
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.15 Field Building
2.13.2.2.3.15.1 Building properties
PropertyValue
Name Building
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.16 Field AddressLine1
2.13.2.2.3.16.1 AddressLine1 properties
PropertyValue
Name AddressLine1
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.17 Field PostalCode
2.13.2.2.3.17.1 PostalCode properties
PropertyValue
Name PostalCode
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.18 Field City
2.13.2.2.3.18.1 City properties
PropertyValue
Name City
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.19 Field Country
2.13.2.2.3.19.1 Country properties
PropertyValue
Name Country
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.20 Field ContractDescription
2.13.2.2.3.20.1 ContractDescription properties
PropertyValue
Name ContractDescription
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.21 Field DateEffectiveContractLine
2.13.2.2.3.21.1 DateEffectiveContractLine properties
PropertyValue
Name DateEffectiveContractLine
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.22 Field EndDateContractLine
2.13.2.2.3.22.1 EndDateContractLine properties
PropertyValue
Name EndDateContractLine
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.23 Field StartDateModification
2.13.2.2.3.23.1 StartDateModification properties
PropertyValue
Name StartDateModification
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.24 Field AmountPer
2.13.2.2.3.24.1 AmountPer properties
PropertyValue
Name AmountPer
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

Weekly Monthly Quarterly HalfYearly Yearly

2.13.2.2.3.25 Field Amount
2.13.2.2.3.25.1 Amount properties
PropertyValue
Name Amount
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.13.2.2.3.26 Field EndDateModification
2.13.2.2.3.26.1 EndDateModification properties
PropertyValue
Name EndDateModification
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.27 Field ContractCurrency
2.13.2.2.3.27.1 ContractCurrency properties
PropertyValue
Name ContractCurrency
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.28 Field BaseC urrency
2.13.2.2.3.28.1 BaseC urrency properties
PropertyValue
Name BaseC urrency
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.29 Field FxRate
2.13.2.2.3.29.1 FxRate properties
PropertyValue
Name FxRate
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.30 Field YearlyTotal
2.13.2.2.3.30.1 YearlyTotal properties
PropertyValue
Name YearlyTotal
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.31 Field ReportingCurrency
2.13.2.2.3.31.1 ReportingCurrency properties
PropertyValue
Name ReportingCurrency
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.32 Field ContractLinePeriod
2.13.2.2.3.32.1 ContractLinePeriod properties
PropertyValue
Name ContractLinePeriod
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.33 Field CostGroup
2.13.2.2.3.33.1 CostGroup properties
PropertyValue
Name CostGroup
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.13.2.2.3.34 Field ProfitCenter
2.13.2.2.3.34.1 ProfitCenter properties
PropertyValue
Name ProfitCenter
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.13.2.2.3.35 Field BusinessArea
2.13.2.2.3.35.1 BusinessArea properties
PropertyValue
Name BusinessArea
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.13.2.2.3.36 Field CostCategory
2.13.2.2.3.36.1 CostCategory properties
PropertyValue
Name CostCategory
Technical name
Activated true
Id
Type number
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.13.2.2.3.37 Field FinancialReportingEntity
2.13.2.2.3.37.1 FinancialReportingEntity properties
PropertyValue
Name FinancialReportingEntity
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.38 Field PaymentInAdvance
2.13.2.2.3.38.1 PaymentInAdvance properties
PropertyValue
Name PaymentInAdvance
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.39 Field PaymentFrequency
2.13.2.2.3.39.1 PaymentFrequency properties
PropertyValue
Name PaymentFrequency
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.40 Field DateofFirstPAyment
2.13.2.2.3.40.1 DateofFirstPAyment properties
PropertyValue
Name DateofFirstPAyment
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.41 Field ShortTermLease
2.13.2.2.3.41.1 ShortTermLease properties
PropertyValue
Name ShortTermLease
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.42 Field AccountingStandard
2.13.2.2.3.42.1 AccountingStandard properties
PropertyValue
Name AccountingStandard
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.43 Field ContractType
2.13.2.2.3.43.1 ContractType properties
PropertyValue
Name ContractType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.3.44 Field DiscountRate
2.13.2.2.3.44.1 DiscountRate properties
PropertyValue
Name DiscountRate
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.2.4 LeaseContract JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "LeaseContract",
    "additionalProperties": false,
    "properties": {
        "CompanyCode": {
            "type": "string"
        },
        "Region": {
            "type": "string"
        },
        "ContractCode": {
            "type": "string"
        },
        "Name": {
            "type": "string"
        },
        "ContractGroup": {
            "type": "string"
        },
        "Lessee": {
            "type": "string"
        },
        "Lessor": {
            "type": "string"
        },
        "ContractStatus": {
            "type": "string"
        },
        "ContractStartDate": {
            "type": "string"
        },
        "ContractEndDate": {
            "type": "string"
        },
        "ContractPeriod": {
            "type": "string"
        },
        "RentalUnit": {
            "type": "string"
        },
        "Space": {
            "type": "string"
        },
        "Floor": {
            "type": "string"
        },
        "Building": {
            "type": "string"
        },
        "AddressLine1": {
            "type": "string"
        },
        "PostalCode": {
            "type": "string"
        },
        "City": {
            "type": "string"
        },
        "Country": {
            "type": "string"
        },
        "ContractDescription": {
            "type": "string"
        },
        "DateEffectiveContractLine": {
            "type": "string"
        },
        "EndDateContractLine": {
            "type": "string"
        },
        "StartDateModification": {
            "type": "string"
        },
        "AmountPer": {
            "type": "string"
        },
        "Amount": {
            "type": "number"
        },
        "EndDateModification": {
            "type": "string"
        },
        "ContractCurrency": {
            "type": "string"
        },
        "BaseC urrency": {
            "type": "string"
        },
        "FxRate": {
            "type": "string"
        },
        "YearlyTotal": {
            "type": "string"
        },
        "ReportingCurrency": {
            "type": "string"
        },
        "ContractLinePeriod": {
            "type": "string"
        },
        "CostGroup": {
            "type": "number"
        },
        "ProfitCenter": {
            "type": "number"
        },
        "BusinessArea": {
            "type": "number"
        },
        "CostCategory": {
            "type": "number"
        },
        "FinancialReportingEntity": {
            "type": "string"
        },
        "PaymentInAdvance": {
            "type": "string"
        },
        "PaymentFrequency": {
            "type": "string"
        },
        "DateofFirstPAyment": {
            "type": "string"
        },
        "ShortTermLease": {
            "type": "string"
        },
        "AccountingStandard": {
            "type": "string"
        },
        "ContractType": {
            "type": "string"
        },
        "DiscountRate": {
            "type": "string"
        }
    }
}
2.13.2.2.5 LeaseContract JSON data
{
    "CompanyCode": "Lorem",
    "Region": "Lorem",
    "ContractCode": "Lorem",
    "Name": "Lorem",
    "ContractGroup": "Lorem",
    "Lessee": "Lorem",
    "Lessor": "Lorem",
    "ContractStatus": "Lorem",
    "ContractStartDate": "Lorem",
    "ContractEndDate": "Lorem",
    "ContractPeriod": "Lorem",
    "RentalUnit": "Lorem",
    "Space": "Lorem",
    "Floor": "Lorem",
    "Building": "Lorem",
    "AddressLine1": "Lorem",
    "PostalCode": "Lorem",
    "City": "Lorem",
    "Country": "Lorem",
    "ContractDescription": "Lorem",
    "DateEffectiveContractLine": "Lorem",
    "EndDateContractLine": "Lorem",
    "StartDateModification": "Lorem",
    "AmountPer": "Lorem",
    "Amount": 16,
    "EndDateModification": "Lorem",
    "ContractCurrency": "Lorem",
    "BaseC urrency": "Lorem",
    "FxRate": "Lorem",
    "YearlyTotal": "Lorem",
    "ReportingCurrency": "Lorem",
    "ContractLinePeriod": "Lorem",
    "CostGroup": -29,
    "ProfitCenter": 42,
    "BusinessArea": 20,
    "CostCategory": -36,
    "FinancialReportingEntity": "Lorem",
    "PaymentInAdvance": "Lorem",
    "PaymentFrequency": "Lorem",
    "DateofFirstPAyment": "Lorem",
    "ShortTermLease": "Lorem",
    "AccountingStandard": "Lorem",
    "ContractType": "Lorem",
    "DiscountRate": "Lorem"
}
2.13.2.3 Document MarketingCampagne
2.13.2.3.1 MarketingCampagne Tree Diagram
2.13.2.3.2 MarketingCampagne Properties
PropertyValue
Document nameMarketingCampagne
Technical name
Activatedtrue
Id
Description
GroupProperty Management
RESTful API
Additional propertiesfalse
Comments
2.13.2.3.3 MarketingCampagne Fields
FieldTypeReqKeyDescriptionComments
CampagneIdstringfalse
2.13.2.3.3.1 Field CampagneId
2.13.2.3.3.1.1 CampagneId properties
PropertyValue
Name CampagneId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.3.4 MarketingCampagne JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "MarketingCampagne",
    "additionalProperties": false,
    "properties": {
        "CampagneId": {
            "type": "string"
        }
    }
}
2.13.2.3.5 MarketingCampagne JSON data
{
    "CampagneId": "Lorem"
}
2.13.2.4 Document RentalContract
2.13.2.4.1 RentalContract Tree Diagram
2.13.2.4.2 RentalContract Properties
PropertyValue
Document nameRentalContract
Technical name
Activatedtrue
Id
Description
GroupProperty Management
RESTful API
Additional propertiesfalse
Comments
2.13.2.4.3 RentalContract Fields
FieldTypeReqKeyDescriptionComments
ContractIdstringfalse
RentalUnitIdstringfalse
Typestringfalse
ValidFromstringfalse

[{"dataType":"dateTime"}]

ValidUntilstringfalse

[{"dataType":"dateTime"}]

FixedLeaseTearmstringfalse
ExtensionOptionstringfalse
RentMonthstringfalse
RentYearstringfalse
AncilarryCoststringfalse
GrossRentMonthstringfalse
GrossRentYearstringfalse
SigningDatestringfalse
ContractStatusstringfalse
TurnoverRentstringfalse
PaymentDatestringfalse
VATrelevantbooleanfalse
RentStartDatestringfalse
Indexationintegerfalse
2.13.2.4.3.1 Field RentalUnitId
2.13.2.4.3.1.1 RentalUnitId properties
PropertyValue
Name RentalUnitId
Technical name Rntlntd
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection RentalUnit
Foreign field RentalUnitId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.4.3.2 Field ContractId
2.13.2.4.3.2.1 ContractId properties
PropertyValue
Name ContractId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.4.3.3 Field Type
2.13.2.4.3.3.1 Type properties
PropertyValue
Name Type
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.4.3.4 Field ValidFrom
2.13.2.4.3.4.1 ValidFrom properties
PropertyValue
Name ValidFrom
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.13.2.4.3.5 Field ValidUntil
2.13.2.4.3.5.1 ValidUntil properties
PropertyValue
Name ValidUntil
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments

[{"dataType":"dateTime"}]

2.13.2.4.3.6 Field FixedLeaseTearm
2.13.2.4.3.6.1 FixedLeaseTearm properties
PropertyValue
Name FixedLeaseTearm
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.4.3.7 Field ExtensionOption
2.13.2.4.3.7.1 ExtensionOption properties
PropertyValue
Name ExtensionOption
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.4.3.8 Field RentMonth
2.13.2.4.3.8.1 RentMonth properties
PropertyValue
Name RentMonth
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.4.3.9 Field RentYear
2.13.2.4.3.9.1 RentYear properties
PropertyValue
Name RentYear
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.4.3.10 Field AncilarryCost
2.13.2.4.3.10.1 AncilarryCost properties
PropertyValue
Name AncilarryCost
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.4.3.11 Field GrossRentMonth
2.13.2.4.3.11.1 GrossRentMonth properties
PropertyValue
Name GrossRentMonth
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.4.3.12 Field GrossRentYear
2.13.2.4.3.12.1 GrossRentYear properties
PropertyValue
Name GrossRentYear
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.4.3.13 Field SigningDate
2.13.2.4.3.13.1 SigningDate properties
PropertyValue
Name SigningDate
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.4.3.14 Field ContractStatus
2.13.2.4.3.14.1 ContractStatus properties
PropertyValue
Name ContractStatus
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.4.3.15 Field TurnoverRent
2.13.2.4.3.15.1 TurnoverRent properties
PropertyValue
Name TurnoverRent
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.4.3.16 Field PaymentDate
2.13.2.4.3.16.1 PaymentDate properties
PropertyValue
Name PaymentDate
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.4.3.17 Field VATrelevant
2.13.2.4.3.17.1 VATrelevant properties
PropertyValue
Name VATrelevant
Technical name
Activated true
Id
Type boolean
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Sample
Comments
2.13.2.4.3.18 Field RentStartDate
2.13.2.4.3.18.1 RentStartDate properties
PropertyValue
Name RentStartDate
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.4.3.19 Field Indexation
2.13.2.4.3.19.1 Indexation properties
PropertyValue
Name Indexation
Technical name
Activated true
Id
Type integer
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Unit
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Sample
Comments
2.13.2.4.4 RentalContract JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "RentalContract",
    "additionalProperties": false,
    "properties": {
        "Rntlntd": {
            "type": "string"
        },
        "ContractId": {
            "type": "string"
        },
        "Type": {
            "type": "string"
        },
        "ValidFrom": {
            "type": "string"
        },
        "ValidUntil": {
            "type": "string"
        },
        "FixedLeaseTearm": {
            "type": "string"
        },
        "ExtensionOption": {
            "type": "string"
        },
        "RentMonth": {
            "type": "string"
        },
        "RentYear": {
            "type": "string"
        },
        "AncilarryCost": {
            "type": "string"
        },
        "GrossRentMonth": {
            "type": "string"
        },
        "GrossRentYear": {
            "type": "string"
        },
        "SigningDate": {
            "type": "string"
        },
        "ContractStatus": {
            "type": "string"
        },
        "TurnoverRent": {
            "type": "string"
        },
        "PaymentDate": {
            "type": "string"
        },
        "VATrelevant": {
            "type": "boolean"
        },
        "RentStartDate": {
            "type": "string"
        },
        "Indexation": {
            "type": "number"
        }
    }
}
2.13.2.4.5 RentalContract JSON data
{
    "Rntlntd": "Lorem",
    "ContractId": "Lorem",
    "Type": "Lorem",
    "ValidFrom": "Lorem",
    "ValidUntil": "Lorem",
    "FixedLeaseTearm": "Lorem",
    "ExtensionOption": "Lorem",
    "RentMonth": "Lorem",
    "RentYear": "Lorem",
    "AncilarryCost": "Lorem",
    "GrossRentMonth": "Lorem",
    "GrossRentYear": "Lorem",
    "SigningDate": "Lorem",
    "ContractStatus": "Lorem",
    "TurnoverRent": "Lorem",
    "PaymentDate": "Lorem",
    "VATrelevant": true,
    "RentStartDate": "Lorem",
    "Indexation": 62
}
2.13.2.5 Document RentalUnit
2.13.2.5.1 RentalUnit Tree Diagram
2.13.2.5.2 RentalUnit Properties
PropertyValue
Document nameRentalUnit
Technical name
Activatedtrue
Id
Description
GroupProperty Management
RESTful API
Additional propertiesfalse
Comments
2.13.2.5.3 RentalUnit Fields
FieldTypeReqKeyDescriptionComments
RentalUnitIdstringfalse
BuildingIdstringfalse
BusinessPartnerIdstringfalse
2.13.2.5.3.1 Field BuildingId
2.13.2.5.3.1.1 BuildingId properties
PropertyValue
Name BuildingId
Technical name Bldngd
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection Building
Foreign field BuildingId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.5.3.2 Field BusinessPartnerId
2.13.2.5.3.2.1 BusinessPartnerId properties
PropertyValue
Name BusinessPartnerId
Technical name BsnssPrtnrd
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection BusinessPartner
Foreign field BusinessPartnerId
Relationship type Foreign Key
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.5.3.3 Field RentalUnitId
2.13.2.5.3.3.1 RentalUnitId properties
PropertyValue
Name RentalUnitId
Technical name Rntlntd
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.5.4 RentalUnit JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "RentalUnit",
    "additionalProperties": false,
    "properties": {
        "Bldngd": {
            "type": "string"
        },
        "BsnssPrtnrd": {
            "type": "string"
        },
        "Rntlntd": {
            "type": "string"
        }
    }
}
2.13.2.5.5 RentalUnit JSON data
{
    "Bldngd": "Lorem",
    "BsnssPrtnrd": "Lorem",
    "Rntlntd": "Lorem"
}
2.13.2.6 Document SecurityDeposit
2.13.2.6.1 SecurityDeposit Tree Diagram
2.13.2.6.2 SecurityDeposit Properties
PropertyValue
Document nameSecurityDeposit
Technical name
Activatedtrue
Id
Description
GroupProperty Management
RESTful API
Additional propertiesfalse
Comments
2.13.2.6.3 SecurityDeposit Fields
FieldTypeReqKeyDescriptionComments
DepositIdstringfalse
2.13.2.6.3.1 Field DepositId
2.13.2.6.3.1.1 DepositId properties
PropertyValue
Name DepositId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.6.4 SecurityDeposit JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "SecurityDeposit",
    "additionalProperties": false,
    "properties": {
        "DepositId": {
            "type": "string"
        }
    }
}
2.13.2.6.5 SecurityDeposit JSON data
{
    "DepositId": "Lorem"
}
2.13.2.7 Document TenantCommunication
2.13.2.7.1 TenantCommunication Tree Diagram
2.13.2.7.2 TenantCommunication Properties
PropertyValue
Document nameTenantCommunication
Technical name
Activatedtrue
Id
Description
GroupProperty Management
RESTful API
Additional propertiesfalse
Comments
2.13.2.7.3 TenantCommunication Fields
FieldTypeReqKeyDescriptionComments
LineIdstringfalse
2.13.2.7.3.1 Field LineId
2.13.2.7.3.1.1 LineId properties
PropertyValue
Name LineId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.13.2.7.4 TenantCommunication JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "TenantCommunication",
    "additionalProperties": false,
    "properties": {
        "LineId": {
            "type": "string"
        }
    }
}
2.13.2.7.5 TenantCommunication JSON data
{
    "LineId": "Lorem"
}
2.14 Group Transaction Management
2.14.1 Transaction Management Properties
PropertyValue
Group nameTransaction Management
Technical name
Activatedtrue
Description
Comments
2.14.2 Transaction Management Documents
2.14.2.1 Document Transaction
2.14.2.1.1 Transaction Tree Diagram
2.14.2.1.2 Transaction Properties
PropertyValue
Document nameTransaction
Technical name
Activatedtrue
Id
Description
GroupTransaction Management
RESTful API
Additional propertiesfalse
Comments
2.14.2.1.3 Transaction Fields
FieldTypeReqKeyDescriptionComments
TransactionIdstringfalse
2.14.2.1.3.1 Field TransactionId
2.14.2.1.3.1.1 TransactionId properties
PropertyValue
Name TransactionId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.14.2.1.4 Transaction JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Transaction",
    "additionalProperties": false,
    "properties": {
        "TransactionId": {
            "type": "string"
        }
    }
}
2.14.2.1.5 Transaction JSON data
{
    "TransactionId": "Lorem"
}
2.14.2.2 Document TransactionContract
2.14.2.2.1 TransactionContract Tree Diagram
2.14.2.2.2 TransactionContract Properties
PropertyValue
Document nameTransactionContract
Technical name
Activatedtrue
Id
Description
GroupTransaction Management
RESTful API
Additional propertiesfalse
Comments
2.14.2.2.3 TransactionContract Fields
FieldTypeReqKeyDescriptionComments
ContractIdstringfalse
2.14.2.2.3.1 Field ContractId
2.14.2.2.3.1.1 ContractId properties
PropertyValue
Name ContractId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.14.2.2.4 TransactionContract JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "TransactionContract",
    "additionalProperties": false,
    "properties": {
        "ContractId": {
            "type": "string"
        }
    }
}
2.14.2.2.5 TransactionContract JSON data
{
    "ContractId": "Lorem"
}
2.14.2.3 Document TransactionOffer
2.14.2.3.1 TransactionOffer Tree Diagram
2.14.2.3.2 TransactionOffer Properties
PropertyValue
Document nameTransactionOffer
Technical name
Activatedtrue
Id
Description
GroupTransaction Management
RESTful API
Additional propertiesfalse
Comments
2.14.2.3.3 TransactionOffer Fields
FieldTypeReqKeyDescriptionComments
TransactionIdstringfalse
2.14.2.3.3.1 Field TransactionId
2.14.2.3.3.1.1 TransactionId properties
PropertyValue
Name TransactionId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.14.2.3.4 TransactionOffer JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "TransactionOffer",
    "additionalProperties": false,
    "properties": {
        "TransactionId": {
            "type": "string"
        }
    }
}
2.14.2.3.5 TransactionOffer JSON data
{
    "TransactionId": "Lorem"
}
2.15 Group UserAndCustomerExperience
2.15.1 UserAndCustomerExperience Properties
PropertyValue
Group nameUserAndCustomerExperience
Technical name
Activatedtrue
Description
Comments
2.15.2 UserAndCustomerExperience Documents
2.15.2.1 Document Furniture
2.15.2.1.1 Furniture Tree Diagram
2.15.2.1.2 Furniture Properties
PropertyValue
Document nameFurniture
Technical name
Activatedtrue
Id
Description
GroupUserAndCustomerExperience
RESTful API
Additional propertiesfalse
Comments
2.15.2.1.3 Furniture Fields
FieldTypeReqKeyDescriptionComments
FurnitureIdstringfalse
2.15.2.1.3.1 Field FurnitureId
2.15.2.1.3.1.1 FurnitureId properties
PropertyValue
Name FurnitureId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.15.2.1.4 Furniture JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Furniture",
    "additionalProperties": false,
    "properties": {
        "FurnitureId": {
            "type": "string"
        }
    }
}
2.15.2.1.5 Furniture JSON data
{
    "FurnitureId": "Lorem"
}
2.15.2.2 Document Occupation
2.15.2.2.1 Occupation Tree Diagram
2.15.2.2.2 Occupation Properties
PropertyValue
Document nameOccupation
Technical name
Activatedtrue
Id
Description
GroupUserAndCustomerExperience
RESTful API
Additional propertiesfalse
Comments
2.15.2.2.3 Occupation Fields
FieldTypeReqKeyDescriptionComments
OccupationIdstringfalse
2.15.2.2.3.1 Field OccupationId
2.15.2.2.3.1.1 OccupationId properties
PropertyValue
Name OccupationId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.15.2.2.4 Occupation JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Occupation",
    "additionalProperties": false,
    "properties": {
        "OccupationId": {
            "type": "string"
        }
    }
}
2.15.2.2.5 Occupation JSON data
{
    "OccupationId": "Lorem"
}
2.15.2.3 Document Reservation
2.15.2.3.1 Reservation Tree Diagram
2.15.2.3.2 Reservation Properties
PropertyValue
Document nameReservation
Technical name
Activatedtrue
Id
Description
GroupUserAndCustomerExperience
RESTful API
Additional propertiesfalse
Comments
2.15.2.3.3 Reservation Fields
FieldTypeReqKeyDescriptionComments
ReservationIdstringfalse
2.15.2.3.3.1 Field ReservationId
2.15.2.3.3.1.1 ReservationId properties
PropertyValue
Name ReservationId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.15.2.3.4 Reservation JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Reservation",
    "additionalProperties": false,
    "properties": {
        "ReservationId": {
            "type": "string"
        }
    }
}
2.15.2.3.5 Reservation JSON data
{
    "ReservationId": "Lorem"
}
2.15.2.4 Document SatisfactionTenantUser
2.15.2.4.1 SatisfactionTenantUser Tree Diagram
2.15.2.4.2 SatisfactionTenantUser Properties
PropertyValue
Document nameSatisfactionTenantUser
Technical name
Activatedtrue
Id
Description
GroupUserAndCustomerExperience
RESTful API
Additional propertiesfalse
Comments
2.15.2.4.3 SatisfactionTenantUser Fields
FieldTypeReqKeyDescriptionComments
TransactionIdstringfalse
2.15.2.4.3.1 Field TransactionId
2.15.2.4.3.1.1 TransactionId properties
PropertyValue
Name TransactionId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.15.2.4.4 SatisfactionTenantUser JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "SatisfactionTenantUser",
    "additionalProperties": false,
    "properties": {
        "TransactionId": {
            "type": "string"
        }
    }
}
2.15.2.4.5 SatisfactionTenantUser JSON data
{
    "TransactionId": "Lorem"
}
2.15.2.5 Document SpaceUtilization
2.15.2.5.1 SpaceUtilization Tree Diagram
2.15.2.5.2 SpaceUtilization Properties
PropertyValue
Document nameSpaceUtilization
Technical name
Activatedtrue
Id
Description
GroupUserAndCustomerExperience
RESTful API
Additional propertiesfalse
Comments
2.15.2.5.3 SpaceUtilization Fields
FieldTypeReqKeyDescriptionComments
UtilizationIdstringfalse
2.15.2.5.3.1 Field UtilizationId
2.15.2.5.3.1.1 UtilizationId properties
PropertyValue
Name UtilizationId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.15.2.5.4 SpaceUtilization JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "SpaceUtilization",
    "additionalProperties": false,
    "properties": {
        "UtilizationId": {
            "type": "string"
        }
    }
}
2.15.2.5.5 SpaceUtilization JSON data
{
    "UtilizationId": "Lorem"
}
2.15.2.6 Document UserRequirements
2.15.2.6.1 UserRequirements Tree Diagram
2.15.2.6.2 UserRequirements Properties
PropertyValue
Document nameUserRequirements
Technical name
Activatedtrue
Id
Description
GroupUserAndCustomerExperience
RESTful API
Additional propertiesfalse
Comments
2.15.2.6.3 UserRequirements Fields
FieldTypeReqKeyDescriptionComments
RequirementIdstringfalse
2.15.2.6.3.1 Field RequirementId
2.15.2.6.3.1.1 RequirementId properties
PropertyValue
Name RequirementId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.15.2.6.4 UserRequirements JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "UserRequirements",
    "additionalProperties": false,
    "properties": {
        "RequirementId": {
            "type": "string"
        }
    }
}
2.15.2.6.5 UserRequirements JSON data
{
    "RequirementId": "Lorem"
}
2.15.2.7 Document Workplace
2.15.2.7.1 Workplace Tree Diagram
2.15.2.7.2 Workplace Properties
PropertyValue
Document nameWorkplace
Technical name
Activatedtrue
Id
Description
GroupUserAndCustomerExperience
RESTful API
Additional propertiesfalse
Comments
2.15.2.7.3 Workplace Fields
FieldTypeReqKeyDescriptionComments
WorkplaceIdstringfalse
AreaIdstringfalse
WorkplaceTypestringfalse
WorkplaceNamestringfalse
2.15.2.7.3.1 Field AreaId
2.15.2.7.3.1.1 AreaId properties
PropertyValue
Name AreaId
Technical name Ard
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.15.2.7.3.2 Field WorkplaceId
2.15.2.7.3.2.1 WorkplaceId properties
PropertyValue
Name WorkplaceId
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key true
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.15.2.7.3.3 Field WorkplaceType
2.15.2.7.3.3.1 WorkplaceType properties
PropertyValue
Name WorkplaceType
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.15.2.7.3.4 Field WorkplaceName
2.15.2.7.3.4.1 WorkplaceName properties
PropertyValue
Name WorkplaceName
Technical name
Activated true
Id
Type string
Description
Dependencies
Required
Primary key false
Foreign collection
Foreign field
Relationship type
Default
Min length
Max length
Pattern
Format
Enum
Sample
Comments
2.15.2.7.4 Workplace JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Workplace",
    "additionalProperties": false,
    "properties": {
        "Ard": {
            "type": "string"
        },
        "WorkplaceId": {
            "type": "string"
        },
        "WorkplaceType": {
            "type": "string"
        },
        "WorkplaceName": {
            "type": "string"
        }
    }
}
2.15.2.7.5 Workplace JSON data
{
    "Ard": "Lorem",
    "WorkplaceId": "Lorem",
    "WorkplaceType": "Lorem",
    "WorkplaceName": "Lorem"
}
3. Relationships
3.1 Relationship fk Address1.AddressId to Building.AddressId
3.1.1 fk Address1.AddressId to Building.AddressId Diagram
Parent TableParent field
Address1 AddressId
Child TableChild field
Building AddressId
3.1.2 fk Address1.AddressId to Building.AddressId Properties
PropertyValue
Name fk Address1.AddressId to Building.AddressId
Description
Parent DocumentAddress1
Parent fieldAddressId
Parent Cardinality 1
Child DocumentBuilding
Child fieldAddressId
Child Cardinality 1
Comments
3.2 Relationship fk Address1.AddressId to Site.AddressId
3.2.1 fk Address1.AddressId to Site.AddressId Diagram
Parent TableParent field
Address1 AddressId
Child TableChild field
Site AddressId
3.2.2 fk Address1.AddressId to Site.AddressId Properties
PropertyValue
Name fk Address1.AddressId to Site.AddressId
Description
Parent DocumentAddress1
Parent fieldAddressId
Parent Cardinality 1
Child DocumentSite
Child fieldAddressId
Child Cardinality 1
Comments
3.3 Relationship fk Address1.AddressId to Unit.AddressId
3.3.1 fk Address1.AddressId to Unit.AddressId Diagram
Parent TableParent field
Address1 AddressId
Child TableChild field
Unit AddressId
3.3.2 fk Address1.AddressId to Unit.AddressId Properties
PropertyValue
Name fk Address1.AddressId to Unit.AddressId
Description
Parent DocumentAddress1
Parent fieldAddressId
Parent Cardinality 1
Child DocumentUnit
Child fieldAddressId
Child Cardinality 1
Comments
3.4 Relationship fk Building.BuildingId to AreaMeasurement.BuildingId
3.4.1 fk Building.BuildingId to AreaMeasurement.BuildingId Diagram
Parent TableParent field
Building BuildingId
Child TableChild field
AreaMeasurement BuildingId
3.4.2 fk Building.BuildingId to AreaMeasurement.BuildingId Properties
PropertyValue
Name fk Building.BuildingId to AreaMeasurement.BuildingId
Description
Parent DocumentBuilding
Parent fieldBuildingId
Parent Cardinality 1
Child DocumentAreaMeasurement
Child fieldBuildingId
Child Cardinality 1
Comments
3.5 Relationship fk Building.BuildingId to Certificate.BuildingId
3.5.1 fk Building.BuildingId to Certificate.BuildingId Diagram
Parent TableParent field
Building BuildingId
Child TableChild field
Certificate BuildingId
3.5.2 fk Building.BuildingId to Certificate.BuildingId Properties
PropertyValue
Name fk Building.BuildingId to Certificate.BuildingId
Description
Parent DocumentBuilding
Parent fieldBuildingId
Parent Cardinality 1
Child DocumentCertificate
Child fieldBuildingId
Child Cardinality 1
Comments
3.6 Relationship fk Building.BuildingId to EmissionFactor.BuildingId
3.6.1 fk Building.BuildingId to EmissionFactor.BuildingId Diagram
Parent TableParent field
Building BuildingId
Child TableChild field
EmissionFactor BuildingId
3.6.2 fk Building.BuildingId to EmissionFactor.BuildingId Properties
PropertyValue
Name fk Building.BuildingId to EmissionFactor.BuildingId
Description
Parent DocumentBuilding
Parent fieldBuildingId
Parent Cardinality 1
Child DocumentEmissionFactor
Child fieldBuildingId
Child Cardinality 1
Comments
3.7 Relationship fk Building.BuildingId to Floor.BuildingId
3.7.1 fk Building.BuildingId to Floor.BuildingId Diagram
Parent TableParent field
Building BuildingId
Child TableChild field
Floor BuildingId
3.7.2 fk Building.BuildingId to Floor.BuildingId Properties
PropertyValue
Name fk Building.BuildingId to Floor.BuildingId
Description
Parent DocumentBuilding
Parent fieldBuildingId
Parent Cardinality 1
Child DocumentFloor
Child fieldBuildingId
Child Cardinality 1
Comments
3.8 Relationship fk Building.BuildingId to OperationalMeasurement.BuildingId
3.8.1 fk Building.BuildingId to OperationalMeasurement.BuildingId Diagram
Parent TableParent field
Building BuildingId
Child TableChild field
OperationalMeasurement BuildingId
3.8.2 fk Building.BuildingId to OperationalMeasurement.BuildingId Properties
PropertyValue
Name fk Building.BuildingId to OperationalMeasurement.BuildingId
Description
Parent DocumentBuilding
Parent fieldBuildingId
Parent Cardinality 1
Child DocumentOperationalMeasurement
Child fieldBuildingId
Child Cardinality 1
Comments
3.9 Relationship fk Building.BuildingId to RentalUnit.BuildingId
3.9.1 fk Building.BuildingId to RentalUnit.BuildingId Diagram
Parent TableParent field
Building BuildingId
Child TableChild field
RentalUnit BuildingId
3.9.2 fk Building.BuildingId to RentalUnit.BuildingId Properties
PropertyValue
Name fk Building.BuildingId to RentalUnit.BuildingId
Description
Parent DocumentBuilding
Parent fieldBuildingId
Parent Cardinality 1
Child DocumentRentalUnit
Child fieldBuildingId
Child Cardinality 1
Comments
3.10 Relationship fk Building.BuildingId to Role.BuildingId
3.10.1 fk Building.BuildingId to Role.BuildingId Diagram
Parent TableParent field
Building BuildingId
Child TableChild field
Role BuildingId
3.10.2 fk Building.BuildingId to Role.BuildingId Properties
PropertyValue
Name fk Building.BuildingId to Role.BuildingId
Description
Parent DocumentBuilding
Parent fieldBuildingId
Parent Cardinality 1
Child DocumentRole
Child fieldBuildingId
Child Cardinality 1
Comments
3.11 Relationship fk Building.BuildingId to SustainabilityIndicators.BuildingId
3.11.1 fk Building.BuildingId to SustainabilityIndicators.BuildingId Diagram
Parent TableParent field
Building BuildingId
Child TableChild field
SustainabilityIndicators BuildingId
3.11.2 fk Building.BuildingId to SustainabilityIndicators.BuildingId Properties
PropertyValue
Name fk Building.BuildingId to SustainabilityIndicators.BuildingId
Description
Parent DocumentBuilding
Parent fieldBuildingId
Parent Cardinality 1
Child DocumentSustainabilityIndicators
Child fieldBuildingId
Child Cardinality 1
Comments
3.12 Relationship fk Building.BuildingId to Unit.BuildingId
3.12.1 fk Building.BuildingId to Unit.BuildingId Diagram
Parent TableParent field
Building BuildingId
Child TableChild field
Unit BuildingId
3.12.2 fk Building.BuildingId to Unit.BuildingId Properties
PropertyValue
Name fk Building.BuildingId to Unit.BuildingId
Description
Parent DocumentBuilding
Parent fieldBuildingId
Parent Cardinality 1
Child DocumentUnit
Child fieldBuildingId
Child Cardinality 1
Comments
3.13 Relationship fk Building.BuildingId to gHgEmissions.BuildingId
3.13.1 fk Building.BuildingId to gHgEmissions.BuildingId Diagram
Parent TableParent field
Building BuildingId
Child TableChild field
gHgEmissions BuildingId
3.13.2 fk Building.BuildingId to gHgEmissions.BuildingId Properties
PropertyValue
Name fk Building.BuildingId to gHgEmissions.BuildingId
Description
Parent DocumentBuilding
Parent fieldBuildingId
Parent Cardinality 1
Child DocumentgHgEmissions
Child fieldBuildingId
Child Cardinality 1
Comments
3.14 Relationship fk BusinessPartner.BusinessPartnerId to EmissionFactor.BusinessPartnerId
3.14.1 fk BusinessPartner.BusinessPartnerId to EmissionFactor.BusinessPartnerId Diagram
Parent TableParent field
BusinessPartner BusinessPartnerId
Child TableChild field
EmissionFactor BusinessPartnerId
3.14.2 fk BusinessPartner.BusinessPartnerId to EmissionFactor.BusinessPartnerId Properties
PropertyValue
Name fk BusinessPartner.BusinessPartnerId to EmissionFactor.BusinessPartnerId
Description
Parent DocumentBusinessPartner
Parent fieldBusinessPartnerId
Parent Cardinality 1
Child DocumentEmissionFactor
Child fieldBusinessPartnerId
Child Cardinality 1
Comments
3.15 Relationship fk BusinessPartner.BusinessPartnerId to OperationalMeasurement.BusinessPartnerId
3.15.1 fk BusinessPartner.BusinessPartnerId to OperationalMeasurement.BusinessPartnerId Diagram
3.15.2 fk BusinessPartner.BusinessPartnerId to OperationalMeasurement.BusinessPartnerId Properties
PropertyValue
Name fk BusinessPartner.BusinessPartnerId to OperationalMeasurement.BusinessPartnerId
Description
Parent DocumentBusinessPartner
Parent fieldBusinessPartnerId
Parent Cardinality 1
Child DocumentOperationalMeasurement
Child fieldBusinessPartnerId
Child Cardinality 1
Comments
3.16 Relationship fk BusinessPartner.BusinessPartnerId to Portfolio.BusinessPartnerId
3.16.1 fk BusinessPartner.BusinessPartnerId to Portfolio.BusinessPartnerId Diagram
Parent TableParent field
BusinessPartner BusinessPartnerId
Child TableChild field
Portfolio BusinessPartnerId
3.16.2 fk BusinessPartner.BusinessPartnerId to Portfolio.BusinessPartnerId Properties
PropertyValue
Name fk BusinessPartner.BusinessPartnerId to Portfolio.BusinessPartnerId
Description
Parent DocumentBusinessPartner
Parent fieldBusinessPartnerId
Parent Cardinality 1
Child DocumentPortfolio
Child fieldBusinessPartnerId
Child Cardinality 1
Comments
3.17 Relationship fk BusinessPartner.BusinessPartnerId to Product.BusinessPartnerId
3.17.1 fk BusinessPartner.BusinessPartnerId to Product.BusinessPartnerId Diagram
Parent TableParent field
BusinessPartner BusinessPartnerId
Child TableChild field
Product BusinessPartnerId
3.17.2 fk BusinessPartner.BusinessPartnerId to Product.BusinessPartnerId Properties
PropertyValue
Name fk BusinessPartner.BusinessPartnerId to Product.BusinessPartnerId
Description
Parent DocumentBusinessPartner
Parent fieldBusinessPartnerId
Parent Cardinality 1
Child DocumentProduct
Child fieldBusinessPartnerId
Child Cardinality 1
Comments
3.18 Relationship fk BusinessPartner.BusinessPartnerId to RentalUnit.BusinessPartnerId
3.18.1 fk BusinessPartner.BusinessPartnerId to RentalUnit.BusinessPartnerId Diagram
Parent TableParent field
BusinessPartner BusinessPartnerId
Child TableChild field
RentalUnit BusinessPartnerId
3.18.2 fk BusinessPartner.BusinessPartnerId to RentalUnit.BusinessPartnerId Properties
PropertyValue
Name fk BusinessPartner.BusinessPartnerId to RentalUnit.BusinessPartnerId
Description
Parent DocumentBusinessPartner
Parent fieldBusinessPartnerId
Parent Cardinality 1
Child DocumentRentalUnit
Child fieldBusinessPartnerId
Child Cardinality 1
Comments
3.19 Relationship fk BusinessPartner.BusinessPartnerId to Site.BusinessPartnerId
3.19.1 fk BusinessPartner.BusinessPartnerId to Site.BusinessPartnerId Diagram
Parent TableParent field
BusinessPartner BusinessPartnerId
Child TableChild field
Site BusinessPartnerId
3.19.2 fk BusinessPartner.BusinessPartnerId to Site.BusinessPartnerId Properties
PropertyValue
Name fk BusinessPartner.BusinessPartnerId to Site.BusinessPartnerId
Description
Parent DocumentBusinessPartner
Parent fieldBusinessPartnerId
Parent Cardinality 1
Child DocumentSite
Child fieldBusinessPartnerId
Child Cardinality 1
Comments
3.20 Relationship fk Certificate.CertificateId to Building.CertificateId
3.20.1 fk Certificate.CertificateId to Building.CertificateId Diagram
Parent TableParent field
Certificate CertificateId
Child TableChild field
Building CertificateId
3.20.2 fk Certificate.CertificateId to Building.CertificateId Properties
PropertyValue
Name fk Certificate.CertificateId to Building.CertificateId
Description
Parent DocumentCertificate
Parent fieldCertificateId
Parent Cardinality 1
Child DocumentBuilding
Child fieldCertificateId
Child Cardinality 1
Comments
3.21 Relationship fk Floor.FloorId to AreaMeasurement.FloorId
3.21.1 fk Floor.FloorId to AreaMeasurement.FloorId Diagram
Parent TableParent field
Floor FloorId
Child TableChild field
AreaMeasurement FloorId
3.21.2 fk Floor.FloorId to AreaMeasurement.FloorId Properties
PropertyValue
Name fk Floor.FloorId to AreaMeasurement.FloorId
Description
Parent DocumentFloor
Parent fieldFloorId
Parent Cardinality 1
Child DocumentAreaMeasurement
Child fieldFloorId
Child Cardinality 1
Comments
3.22 Relationship fk Floor.FloorId to OperationalMeasurement.FloorId
3.22.1 fk Floor.FloorId to OperationalMeasurement.FloorId Diagram
Parent TableParent field
Floor FloorId
Child TableChild field
OperationalMeasurement FloorId
3.22.2 fk Floor.FloorId to OperationalMeasurement.FloorId Properties
PropertyValue
Name fk Floor.FloorId to OperationalMeasurement.FloorId
Description
Parent DocumentFloor
Parent fieldFloorId
Parent Cardinality 1
Child DocumentOperationalMeasurement
Child fieldFloorId
Child Cardinality 1
Comments
3.23 Relationship fk Floor.FloorId to Space.FloorId
3.23.1 fk Floor.FloorId to Space.FloorId Diagram
Parent TableParent field
Floor FloorId
Child TableChild field
Space FloorId
3.23.2 fk Floor.FloorId to Space.FloorId Properties
PropertyValue
Name fk Floor.FloorId to Space.FloorId
Description
Parent DocumentFloor
Parent fieldFloorId
Parent Cardinality 1
Child DocumentSpace
Child fieldFloorId
Child Cardinality 1
Comments
3.24 Relationship fk Floor.FloorId to Unit.FloorId
3.24.1 fk Floor.FloorId to Unit.FloorId Diagram
Parent TableParent field
Floor FloorId
Child TableChild field
Unit FloorId
3.24.2 fk Floor.FloorId to Unit.FloorId Properties
PropertyValue
Name fk Floor.FloorId to Unit.FloorId
Description
Parent DocumentFloor
Parent fieldFloorId
Parent Cardinality 1
Child DocumentUnit
Child fieldFloorId
Child Cardinality 1
Comments
3.25 Relationship fk Land.LandId to AreaMeasurement.LandId
3.25.1 fk Land.LandId to AreaMeasurement.LandId Diagram
Parent TableParent field
Land LandId
Child TableChild field
AreaMeasurement LandId
3.25.2 fk Land.LandId to AreaMeasurement.LandId Properties
PropertyValue
Name fk Land.LandId to AreaMeasurement.LandId
Description
Parent DocumentLand
Parent fieldLandId
Parent Cardinality 1
Child DocumentAreaMeasurement
Child fieldLandId
Child Cardinality 1
Comments
3.26 Relationship fk Land.LandId to Building.LandId
3.26.1 fk Land.LandId to Building.LandId Diagram
Parent TableParent field
Land LandId
Child TableChild field
Building LandId
3.26.2 fk Land.LandId to Building.LandId Properties
PropertyValue
Name fk Land.LandId to Building.LandId
Description
Parent DocumentLand
Parent fieldLandId
Parent Cardinality 1
Child DocumentBuilding
Child fieldLandId
Child Cardinality 1
Comments
3.27 Relationship fk Land.LandId to OperationalMeasurement.LandId
3.27.1 fk Land.LandId to OperationalMeasurement.LandId Diagram
Parent TableParent field
Land LandId
Child TableChild field
OperationalMeasurement LandId
3.27.2 fk Land.LandId to OperationalMeasurement.LandId Properties
PropertyValue
Name fk Land.LandId to OperationalMeasurement.LandId
Description
Parent DocumentLand
Parent fieldLandId
Parent Cardinality 1
Child DocumentOperationalMeasurement
Child fieldLandId
Child Cardinality 1
Comments
3.28 Relationship fk Land.LandId to Servitudes.LandId
3.28.1 fk Land.LandId to Servitudes.LandId Diagram
Parent TableParent field
Land LandId
Child TableChild field
Servitudes LandId
3.28.2 fk Land.LandId to Servitudes.LandId Properties
PropertyValue
Name fk Land.LandId to Servitudes.LandId
Description
Parent DocumentLand
Parent fieldLandId
Parent Cardinality 1
Child DocumentServitudes
Child fieldLandId
Child Cardinality 1
Comments
3.29 Relationship fk Land.LandId to Unit.LandId
3.29.1 fk Land.LandId to Unit.LandId Diagram
Parent TableParent field
Land LandId
Child TableChild field
Unit LandId
3.29.2 fk Land.LandId to Unit.LandId Properties
PropertyValue
Name fk Land.LandId to Unit.LandId
Description
Parent DocumentLand
Parent fieldLandId
Parent Cardinality 1
Child DocumentUnit
Child fieldLandId
Child Cardinality 1
Comments
3.30 Relationship fk OperationalMeasurement.GUID to EmissionFactor.OperationalMeasurementId
3.30.1 fk OperationalMeasurement.GUID to EmissionFactor.OperationalMeasurementId Diagram
3.30.2 fk OperationalMeasurement.GUID to EmissionFactor.OperationalMeasurementId Properties
PropertyValue
Name fk OperationalMeasurement.GUID to EmissionFactor.OperationalMeasurementId
Description
Parent DocumentOperationalMeasurement
Parent fieldGuid
Parent Cardinality 1
Child DocumentEmissionFactor
Child fieldOperationalMeasurementGuid
Child Cardinality 1
Comments
3.31 Relationship fk OperationalMeasurement.Guid to gHgEmissions.OperationalMeasurementId
3.31.1 fk OperationalMeasurement.Guid to gHgEmissions.OperationalMeasurementId Diagram
Parent TableParent field
OperationalMeasurement Guid
Child TableChild field
gHgEmissions OperationalMeasurementGuid
3.31.2 fk OperationalMeasurement.Guid to gHgEmissions.OperationalMeasurementId Properties
PropertyValue
Name fk OperationalMeasurement.Guid to gHgEmissions.OperationalMeasurementId
Description
Parent DocumentOperationalMeasurement
Parent fieldGuid
Parent Cardinality 1
Child DocumentgHgEmissions
Child fieldOperationalMeasurementGuid
Child Cardinality 1
Comments
3.32 Relationship fk Portfolio.PortfolioId to Building.PortfolioId
3.32.1 fk Portfolio.PortfolioId to Building.PortfolioId Diagram
Parent TableParent field
Portfolio PortfolioId
Child TableChild field
Building PortfolioId
3.32.2 fk Portfolio.PortfolioId to Building.PortfolioId Properties
PropertyValue
Name fk Portfolio.PortfolioId to Building.PortfolioId
Description
Parent DocumentPortfolio
Parent fieldPortfolioId
Parent Cardinality 1
Child DocumentBuilding
Child fieldPortfolioId
Child Cardinality 1
Comments
3.33 Relationship fk Portfolio.PortfolioId to OperationalMeasurement.PortfolioId
3.33.1 fk Portfolio.PortfolioId to OperationalMeasurement.PortfolioId Diagram
Parent TableParent field
Portfolio PortfolioId
Child TableChild field
OperationalMeasurement PortfolioId
3.33.2 fk Portfolio.PortfolioId to OperationalMeasurement.PortfolioId Properties
PropertyValue
Name fk Portfolio.PortfolioId to OperationalMeasurement.PortfolioId
Description
Parent DocumentPortfolio
Parent fieldPortfolioId
Parent Cardinality 1
Child DocumentOperationalMeasurement
Child fieldPortfolioId
Child Cardinality 1
Comments
3.34 Relationship fk Product.ProductId to BSensingObject.ProductId
3.34.1 fk Product.ProductId to BSensingObject.ProductId Diagram
Parent TableParent field
Product ProductId
Child TableChild field
BSensingObject ProductId
3.34.2 fk Product.ProductId to BSensingObject.ProductId Properties
PropertyValue
Name fk Product.ProductId to BSensingObject.ProductId
Description
Parent DocumentProduct
Parent fieldProductId
Parent Cardinality 1
Child DocumentBSensingObject
Child fieldProductId
Child Cardinality 1
Comments
3.35 Relationship fk Product.ProductId to CStoringObject.ProductId
3.35.1 fk Product.ProductId to CStoringObject.ProductId Diagram
Parent TableParent field
Product ProductId
Child TableChild field
CStoringObject ProductId
3.35.2 fk Product.ProductId to CStoringObject.ProductId Properties
PropertyValue
Name fk Product.ProductId to CStoringObject.ProductId
Description
Parent DocumentProduct
Parent fieldProductId
Parent Cardinality 1
Child DocumentCStoringObject
Child fieldProductId
Child Cardinality 1
Comments
3.36 Relationship fk Product.ProductId to EEmittingObject.ProductId
3.36.1 fk Product.ProductId to EEmittingObject.ProductId Diagram
Parent TableParent field
Product ProductId
Child TableChild field
EEmittingObject ProductId
3.36.2 fk Product.ProductId to EEmittingObject.ProductId Properties
PropertyValue
Name fk Product.ProductId to EEmittingObject.ProductId
Description
Parent DocumentProduct
Parent fieldProductId
Parent Cardinality 1
Child DocumentEEmittingObject
Child fieldProductId
Child Cardinality 1
Comments
3.37 Relationship fk Product.ProductId to FProtectingObject.ProductId
3.37.1 fk Product.ProductId to FProtectingObject.ProductId Diagram
Parent TableParent field
Product ProductId
Child TableChild field
FProtectingObject ProductId
3.37.2 fk Product.ProductId to FProtectingObject.ProductId Properties
PropertyValue
Name fk Product.ProductId to FProtectingObject.ProductId
Description
Parent DocumentProduct
Parent fieldProductId
Parent Cardinality 1
Child DocumentFProtectingObject
Child fieldProductId
Child Cardinality 1
Comments
3.38 Relationship fk Product.ProductId to GGeneratingObject.ProductId
3.38.1 fk Product.ProductId to GGeneratingObject.ProductId Diagram
Parent TableParent field
Product ProductId
Child TableChild field
GGeneratingObject ProductId
3.38.2 fk Product.ProductId to GGeneratingObject.ProductId Properties
PropertyValue
Name fk Product.ProductId to GGeneratingObject.ProductId
Description
Parent DocumentProduct
Parent fieldProductId
Parent Cardinality 1
Child DocumentGGeneratingObject
Child fieldProductId
Child Cardinality 1
Comments
3.39 Relationship fk Product.ProductId to HMatterProcessingObject.ProductId
3.39.1 fk Product.ProductId to HMatterProcessingObject.ProductId Diagram
Parent TableParent field
Product ProductId
Child TableChild field
HMatterProcessingObject ProductId
3.39.2 fk Product.ProductId to HMatterProcessingObject.ProductId Properties
PropertyValue
Name fk Product.ProductId to HMatterProcessingObject.ProductId
Description
Parent DocumentProduct
Parent fieldProductId
Parent Cardinality 1
Child DocumentHMatterProcessingObject
Child fieldProductId
Child Cardinality 1
Comments
3.40 Relationship fk Product.ProductId to MDrivingObject.ProductId
3.40.1 fk Product.ProductId to MDrivingObject.ProductId Diagram
Parent TableParent field
Product ProductId
Child TableChild field
MDrivingObject ProductId
3.40.2 fk Product.ProductId to MDrivingObject.ProductId Properties
PropertyValue
Name fk Product.ProductId to MDrivingObject.ProductId
Description
Parent DocumentProduct
Parent fieldProductId
Parent Cardinality 1
Child DocumentMDrivingObject
Child fieldProductId
Child Cardinality 1
Comments
3.41 Relationship fk Product.ProductId to QControllingObject.ProductId
3.41.1 fk Product.ProductId to QControllingObject.ProductId Diagram
Parent TableParent field
Product ProductId
Child TableChild field
QControllingObject ProductId
3.41.2 fk Product.ProductId to QControllingObject.ProductId Properties
PropertyValue
Name fk Product.ProductId to QControllingObject.ProductId
Description
Parent DocumentProduct
Parent fieldProductId
Parent Cardinality 1
Child DocumentQControllingObject
Child fieldProductId
Child Cardinality 1
Comments
3.42 Relationship fk Product.ProductId to RRestrictingObject.ProductId
3.42.1 fk Product.ProductId to RRestrictingObject.ProductId Diagram
Parent TableParent field
Product ProductId
Child TableChild field
RRestrictingObject ProductId
3.42.2 fk Product.ProductId to RRestrictingObject.ProductId Properties
PropertyValue
Name fk Product.ProductId to RRestrictingObject.ProductId
Description
Parent DocumentProduct
Parent fieldProductId
Parent Cardinality 1
Child DocumentRRestrictingObject
Child fieldProductId
Child Cardinality 1
Comments
3.43 Relationship fk Product.ProductId to UHoldingObject.ProductId
3.43.1 fk Product.ProductId to UHoldingObject.ProductId Diagram
Parent TableParent field
Product ProductId
Child TableChild field
UHoldingObject ProductId
3.43.2 fk Product.ProductId to UHoldingObject.ProductId Properties
PropertyValue
Name fk Product.ProductId to UHoldingObject.ProductId
Description
Parent DocumentProduct
Parent fieldProductId
Parent Cardinality 1
Child DocumentUHoldingObject
Child fieldProductId
Child Cardinality 1
Comments
3.44 Relationship fk Product.ProductId to XInterfacingObject.ProductId
3.44.1 fk Product.ProductId to XInterfacingObject.ProductId Diagram
Parent TableParent field
Product ProductId
Child TableChild field
XInterfacingObject ProductId
3.44.2 fk Product.ProductId to XInterfacingObject.ProductId Properties
PropertyValue
Name fk Product.ProductId to XInterfacingObject.ProductId
Description
Parent DocumentProduct
Parent fieldProductId
Parent Cardinality 1
Child DocumentXInterfacingObject
Child fieldProductId
Child Cardinality 1
Comments
3.45 Relationship fk RentalUnit.RentalUnitId to RentalContract.RentalUnitId
3.45.1 fk RentalUnit.RentalUnitId to RentalContract.RentalUnitId Diagram
Parent TableParent field
RentalUnit RentalUnitId
Child TableChild field
RentalContract RentalUnitId
3.45.2 fk RentalUnit.RentalUnitId to RentalContract.RentalUnitId Properties
PropertyValue
Name fk RentalUnit.RentalUnitId to RentalContract.RentalUnitId
Description
Parent DocumentRentalUnit
Parent fieldRentalUnitId
Parent Cardinality 1
Child DocumentRentalContract
Child fieldRentalUnitId
Child Cardinality 1
Comments
3.46 Relationship fk Site.SiteId to AreaMeasurement.SiteId
3.46.1 fk Site.SiteId to AreaMeasurement.SiteId Diagram
Parent TableParent field
Site SiteId
Child TableChild field
AreaMeasurement SiteId
3.46.2 fk Site.SiteId to AreaMeasurement.SiteId Properties
PropertyValue
Name fk Site.SiteId to AreaMeasurement.SiteId
Description
Parent DocumentSite
Parent fieldSiteId
Parent Cardinality 1
Child DocumentAreaMeasurement
Child fieldSiteId
Child Cardinality 1
Comments
3.47 Relationship fk Site.SiteId to Building.SiteId
3.47.1 fk Site.SiteId to Building.SiteId Diagram
Parent TableParent field
Site SiteId
Child TableChild field
Building SiteId
3.47.2 fk Site.SiteId to Building.SiteId Properties
PropertyValue
Name fk Site.SiteId to Building.SiteId
Description
Parent DocumentSite
Parent fieldSiteId
Parent Cardinality 1
Child DocumentBuilding
Child fieldSiteId
Child Cardinality 1
Comments
3.48 Relationship fk Site.SiteId to EmissionFactor.SiteId
3.48.1 fk Site.SiteId to EmissionFactor.SiteId Diagram
Parent TableParent field
Site SiteId
Child TableChild field
EmissionFactor SiteId
3.48.2 fk Site.SiteId to EmissionFactor.SiteId Properties
PropertyValue
Name fk Site.SiteId to EmissionFactor.SiteId
Description
Parent DocumentSite
Parent fieldSiteId
Parent Cardinality 1
Child DocumentEmissionFactor
Child fieldSiteId
Child Cardinality 1
Comments
3.49 Relationship fk Site.SiteId to Land.SiteId
3.49.1 fk Site.SiteId to Land.SiteId Diagram
Parent TableParent field
Site SiteId
Child TableChild field
Land SiteId
3.49.2 fk Site.SiteId to Land.SiteId Properties
PropertyValue
Name fk Site.SiteId to Land.SiteId
Description
Parent DocumentSite
Parent fieldSiteId
Parent Cardinality 1
Child DocumentLand
Child fieldSiteId
Child Cardinality 1
Comments
3.50 Relationship fk Site.SiteId to OperationalMeasurement.SiteId
3.50.1 fk Site.SiteId to OperationalMeasurement.SiteId Diagram
Parent TableParent field
Site SiteId
Child TableChild field
OperationalMeasurement SiteId
3.50.2 fk Site.SiteId to OperationalMeasurement.SiteId Properties
PropertyValue
Name fk Site.SiteId to OperationalMeasurement.SiteId
Description
Parent DocumentSite
Parent fieldSiteId
Parent Cardinality 1
Child DocumentOperationalMeasurement
Child fieldSiteId
Child Cardinality 1
Comments
3.51 Relationship fk Site.SiteId to Unit.SiteId
3.51.1 fk Site.SiteId to Unit.SiteId Diagram
Parent TableParent field
Site SiteId
Child TableChild field
Unit SiteId
3.51.2 fk Site.SiteId to Unit.SiteId Properties
PropertyValue
Name fk Site.SiteId to Unit.SiteId
Description
Parent DocumentSite
Parent fieldSiteId
Parent Cardinality 1
Child DocumentUnit
Child fieldSiteId
Child Cardinality 1
Comments
3.52 Relationship fk Site.SiteId to gHgEmissions.SiteId
3.52.1 fk Site.SiteId to gHgEmissions.SiteId Diagram
Parent TableParent field
Site SiteId
Child TableChild field
gHgEmissions SiteId
3.52.2 fk Site.SiteId to gHgEmissions.SiteId Properties
PropertyValue
Name fk Site.SiteId to gHgEmissions.SiteId
Description
Parent DocumentSite
Parent fieldSiteId
Parent Cardinality 1
Child DocumentgHgEmissions
Child fieldSiteId
Child Cardinality 1
Comments
3.53 Relationship fk Space.SpaceId to AreaMeasurement.SpaceId
3.53.1 fk Space.SpaceId to AreaMeasurement.SpaceId Diagram
Parent TableParent field
Space SpaceId
Child TableChild field
AreaMeasurement SpaceId
3.53.2 fk Space.SpaceId to AreaMeasurement.SpaceId Properties
PropertyValue
Name fk Space.SpaceId to AreaMeasurement.SpaceId
Description
Parent DocumentSpace
Parent fieldSpaceId
Parent Cardinality 1
Child DocumentAreaMeasurement
Child fieldSpaceId
Child Cardinality 1
Comments
3.54 Relationship fk Space.SpaceId to OperationalMeasurement.SpaceId
3.54.1 fk Space.SpaceId to OperationalMeasurement.SpaceId Diagram
Parent TableParent field
Space SpaceId
Child TableChild field
OperationalMeasurement SpaceId
3.54.2 fk Space.SpaceId to OperationalMeasurement.SpaceId Properties
PropertyValue
Name fk Space.SpaceId to OperationalMeasurement.SpaceId
Description
Parent DocumentSpace
Parent fieldSpaceId
Parent Cardinality 1
Child DocumentOperationalMeasurement
Child fieldSpaceId
Child Cardinality 1
Comments
3.55 Relationship fk Space.SpaceId to Product.SpaceId
3.55.1 fk Space.SpaceId to Product.SpaceId Diagram
Parent TableParent field
Space SpaceId
Child TableChild field
Product SpaceId
3.55.2 fk Space.SpaceId to Product.SpaceId Properties
PropertyValue
Name fk Space.SpaceId to Product.SpaceId
Description
Parent DocumentSpace
Parent fieldSpaceId
Parent Cardinality 1
Child DocumentProduct
Child fieldSpaceId
Child Cardinality 1
Comments
3.56 Relationship fk Space.SpaceId to Unit.SpaceId
3.56.1 fk Space.SpaceId to Unit.SpaceId Diagram
Parent TableParent field
Space SpaceId
Child TableChild field
Unit SpaceId
3.56.2 fk Space.SpaceId to Unit.SpaceId Properties
PropertyValue
Name fk Space.SpaceId to Unit.SpaceId
Description
Parent DocumentSpace
Parent fieldSpaceId
Parent Cardinality 1
Child DocumentUnit
Child fieldSpaceId
Child Cardinality 1
Comments
3.57 Relationship fk Unit.UnitId to AreaMeasurement.UnitId
3.57.1 fk Unit.UnitId to AreaMeasurement.UnitId Diagram
Parent TableParent field
Unit UnitId
Child TableChild field
AreaMeasurement UnitId
3.57.2 fk Unit.UnitId to AreaMeasurement.UnitId Properties
PropertyValue
Name fk Unit.UnitId to AreaMeasurement.UnitId
Description
Parent DocumentUnit
Parent fieldUnitId
Parent Cardinality 1
Child DocumentAreaMeasurement
Child fieldUnitId
Child Cardinality 1
Comments
3.58 Relationship fk Workplace.WorkplaceId to Measurement.WorkplaceId
3.58.1 fk Workplace.WorkplaceId to Measurement.WorkplaceId Diagram
Parent TableParent field
Workplace WorkplaceId
Child TableChild field
AreaMeasurement ValidFrom
3.58.2 fk Workplace.WorkplaceId to Measurement.WorkplaceId Properties
PropertyValue
Name fk Workplace.WorkplaceId to Measurement.WorkplaceId
Description
Parent DocumentWorkplace
Parent fieldWorkplaceId
Parent Cardinality 1
Child DocumentAreaMeasurement
Child fieldValidFrom
Child Cardinality n
Comments
3.59 Relationship fk Workplace.WorkplaceId to OperationalMeasurement.WorkplaceId
3.59.1 fk Workplace.WorkplaceId to OperationalMeasurement.WorkplaceId Diagram
Parent TableParent field
Workplace WorkplaceId
Child TableChild field
OperationalMeasurement WorkplaceId
3.59.2 fk Workplace.WorkplaceId to OperationalMeasurement.WorkplaceId Properties
PropertyValue
Name fk Workplace.WorkplaceId to OperationalMeasurement.WorkplaceId
Description
Parent DocumentWorkplace
Parent fieldWorkplaceId
Parent Cardinality 1
Child DocumentOperationalMeasurement
Child fieldWorkplaceId
Child Cardinality 1
Comments